Commit edac742
authored
docs: Reorg and improve user experience (#4629)
* docs: Reorg and improve user experience
Reorganize and improve documentation to provide a better
getting started and documentation navigation user experience.
Included changes:
- 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.
- Implement consistent file and folder naming optimized for SEO.
Closes: aboutcode-org/www.aboutcode.org/issues/39.
Signed-off-by: Thomas Steenbergen <opensource@steenbe.nl>
* Update outdated documentation sections
Also update documentation formatting and pages layout/sections.
Signed-off-by: Ayan Sinha Mahapatra <asmahapatra@aboutcode.org>
---------
Signed-off-by: Thomas Steenbergen <opensource@steenbe.nl>
Signed-off-by: Ayan Sinha Mahapatra <asmahapatra@aboutcode.org>
Co-authored-by: Ayan Sinha Mahapatra <asmahapatra@aboutcode.org>File tree
135 files changed
+1904
-2399
lines changed- docs/source
- _static
- cli-reference
- contribute
- explanation
- getting-started
- contribute
- data
- gsoc
- installation
- how-to-guides
- data
- misc
- plugins
- reference
- scancode-cli
- data
- scancode-plugins
- rst-snippets
- note-snippets
- warning-snippets
- rst_snippets
- tip_snippets
- tutorials
- data
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
135 files changed
+1904
-2399
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
111 | 111 | | |
112 | 112 | | |
113 | 113 | | |
114 | | - | |
| 114 | + | |
115 | 115 | | |
116 | 116 | | |
117 | 117 | | |
| |||
128 | 128 | | |
129 | 129 | | |
130 | 130 | | |
131 | | - | |
| 131 | + | |
132 | 132 | | |
133 | 133 | | |
134 | 134 | | |
| |||
159 | 159 | | |
160 | 160 | | |
161 | 161 | | |
162 | | - | |
| 162 | + | |
163 | 163 | | |
164 | 164 | | |
165 | 165 | | |
| |||
202 | 202 | | |
203 | 203 | | |
204 | 204 | | |
205 | | - | |
| 205 | + | |
206 | 206 | | |
207 | 207 | | |
208 | 208 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
This file was deleted.
This file was deleted.
This file was deleted.
0 commit comments