Skip to content

Commit edac742

Browse files
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>
2 parents 042147d + 2a1f596 commit edac742

File tree

135 files changed

+1904
-2399
lines changed

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

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ If you are new to visualization of scancode results data, start with our
111111
`newcomer <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/newcomer.html>`_ page.
112112

113113
If you want to compare output changes between different versions of ScanCode,
114-
or want to look at scans generated by ScanCode, review our
114+
or want to look at scans generated by ScanCode, review our
115115
`reference scans <https://github.com/nexB/scancode-toolkit-reference-scans>`_.
116116

117117
Other Important Documentation Pages:
@@ -128,7 +128,7 @@ Other Important Documentation Pages:
128128

129129
- Documentation on `Contributing to Code Development <https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_dev.html>`_
130130

131-
- Documentation on `Plugin Architecture <https://scancode-toolkit.readthedocs.io/en/latest/plugins/plugin_arch.html>`_
131+
- Documentation on `Plugin Architecture <https://scancode-toolkit.readthedocs.io/en/latest/plugins/plugin-architecture.html>`_
132132

133133
- `FAQ <https://scancode-toolkit.readthedocs.io/en/latest/misc/faq.html>`_
134134

@@ -159,7 +159,7 @@ There are a few common ways to `install ScanCode <https://scancode-toolkit.readt
159159
[Note that this is not supported on arm64 machines]
160160

161161
- `Run in a Docker container with a git clone and "docker run"
162-
<https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-via-docker>`_
162+
<https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-using-docker>`_
163163

164164
- In Fedora 40+ you can `dnf install scancode-toolkit`
165165

@@ -202,7 +202,7 @@ directory::
202202

203203
./extractcode mytar.tar.bz2
204204

205-
See `all extractcode options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html#all-extractcode-options>`_
205+
See `all extractcode options <https://scancode-toolkit.readthedocs.io/en/latest/reference/cli-extractcode.html>`_
206206
and `how to extract archives <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_extract_archives.html>`_ for details.
207207

208208

docs/source/_static/theme_overrides.css

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,50 @@ div.rst-content {
2424
margin-left: 0px;
2525
}
2626
}
27+
28+
.row {
29+
clear: both;
30+
}
31+
32+
.column img {
33+
border: 1px solid gray;
34+
}
35+
36+
@media only screen and (min-width: 1000px),
37+
only screen and (min-width: 500px) and (max-width: 768px) {
38+
39+
.column {
40+
padding-left: 5px;
41+
padding-right: 5px;
42+
float: left;
43+
}
44+
45+
.column3 {
46+
width: calc(33.3% - 10px);
47+
}
48+
49+
.column2 {
50+
width: calc(50% - 11px);
51+
position: relative;
52+
}
53+
54+
.column2:before {
55+
padding-top: 61.8%;
56+
content: "";
57+
display: block;
58+
float: left;
59+
}
60+
61+
.top-left {
62+
border-right: 1px solid var(--color-background-border);
63+
border-bottom: 1px solid var(--color-background-border);
64+
}
65+
66+
.top-right {
67+
border-bottom: 1px solid var(--color-background-border);
68+
}
69+
70+
.bottom-left {
71+
border-right: 1px solid var(--color-background-border);
72+
}
73+
}

docs/source/cli-reference/index.rst

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/source/cli-reference/list-options.rst

Lines changed: 0 additions & 51 deletions
This file was deleted.

docs/source/cli-reference/simple-examples.rst

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)