Commit e51365a
docs: Reorg and improve user experience
Reorganize and improve documentation to provide a better getting started
and documentation navigation user experience.
This pull requests includes:
- Adoption of the Diátaxis framework which prioritizes user needs and
organizes documentation accordingly. This approach ensures users can
easily find the information they need while providing authors with
clear guidance on improving documentation for a better user experience.
- A new tutorial on how to use ORT
- Several how-to guides have been added explaining how to accomplish
specific tasks with ORT
- Introduces a new explanation section to provide background and context
e.g. the 'why' things are so
(design decisions, historical reasons, technical constraints)
Co-authored-by: Jonatan Männchen <jonatan@maennchen.ch>
Signed-off-by: Jonatan Männchen <jonatan@maennchen.ch>
Signed-off-by: Thomas Steenbergen <opensource@steenbe.nl>1 parent 1c51723 commit e51365a
83 files changed
Lines changed: 3870 additions & 1696 deletions
File tree
- buildSrc/src/main/kotlin
- website
- docs
- about
- configuration
- explanation
- getting-started
- guides
- how-to-guides
- plugins
- advisors
- license-fact-providers
- package-configuration-providers
- package-curation-providers
- package-managers
- reporters
- scanners
- reference
- cli
- configuration
- plugins
- tools
- tutorials
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
| 40 | + | |
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
| |||
Lines changed: 14 additions & 15 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
2 | | - | |
3 | | - | |
4 | | - | |
5 | | - | |
6 | 1 | | |
7 | 2 | | |
8 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
9 | 16 | | |
10 | 17 | | |
11 | 18 | | |
| |||
17 | 24 | | |
18 | 25 | | |
19 | 26 | | |
20 | | - | |
| 27 | + | |
21 | 28 | | |
22 | 29 | | |
23 | 30 | | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
29 | | - | |
30 | | - | |
31 | | - | |
32 | 31 | | |
33 | 32 | | |
34 | 33 | | |
| |||
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
0 commit comments