Skip to content

Commit 1e2a4e2

Browse files
dhellmannclaude
andcommitted
docs: enhance how-to navigation with categories (Phase 3)
Reorganize how-to guides with clear categories and popular guides section for improved discoverability. Changes: - Add "Popular Guides" section with links to most common tasks - Categorize guides into logical groups: * Getting Started: containers, bootstrap-constraints * Building Packages: git repos, repeatable builds, parallel, web server * Build Configuration: pyproject overrides, multiple versions, pre-releases * Analyzing Builds: graph commands - Add descriptive text explaining guide categories - Add "See Also" section linking to customization and reference docs Impact: Users can quickly scan categories and find relevant guides Related: #969 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 85cfb5b commit 1e2a4e2

1 file changed

Lines changed: 61 additions & 3 deletions

File tree

docs/how-tos/index.rst

Lines changed: 61 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,67 @@
11
How-tos
22
=======
33

4+
Task-oriented guides for common workflows and customization scenarios.
5+
6+
Popular Guides
7+
--------------
8+
9+
Quick links to frequently used guides:
10+
11+
* :doc:`containers` - Running fromager in containers (recommended approach)
12+
* :doc:`bootstrap-constraints` - Pin versions for reproducible builds
13+
* :doc:`graph-commands/using-graph-why` - Debug unexpected dependencies
14+
* :doc:`repeatable-builds` - Ensure build reproducibility
15+
16+
Getting Started
17+
---------------
18+
19+
Essential guides for initial setup and first builds.
20+
21+
.. toctree::
22+
:maxdepth: 1
23+
24+
containers
25+
bootstrap-constraints
26+
27+
Building Packages
28+
-----------------
29+
30+
Guides for building packages from various sources and configurations.
31+
32+
.. toctree::
33+
:maxdepth: 1
34+
35+
build-from-git-repo
36+
repeatable-builds
37+
parallel
38+
build-web-server
39+
40+
Build Configuration
41+
-------------------
42+
43+
Customize builds with overrides, variants, and version handling.
44+
445
.. toctree::
546
:maxdepth: 1
6-
:glob:
747

8-
*
9-
*/index
48+
pyproject-overrides
49+
multiple-versions
50+
pre-release-versions
51+
52+
Analyzing Builds
53+
----------------
54+
55+
Understand and debug dependency graphs and build issues.
56+
57+
.. toctree::
58+
:maxdepth: 1
59+
60+
graph-commands/index
61+
62+
See Also
63+
--------
64+
65+
* :doc:`/customization` - Comprehensive guide to customization options
66+
* :doc:`/reference/config-reference` - Configuration reference
67+
* :doc:`/reference/hooks` - Override plugins and hooks

0 commit comments

Comments
 (0)