Skip to content

Commit e851197

Browse files
dhellmannclaude
andcommitted
docs: add cross-references for improved navigation (Phase 4)
Add "Next Steps" and "See Also" sections to key pages to help users discover related content and navigate naturally between topics. Changes: - Enhanced quickstart.rst with categorized next steps (Learn More, Common Tasks, Customize Builds) - Added next steps to getting-started.rst linking to containers, constraints, customization, and concepts - Added "See Also" section to customization.md with links to reference docs and related how-tos - Added "See Also" section to using.md with links to concepts and how-to guides - Enhanced concepts/index.rst with overview, related guides, and reference links Impact: Users can naturally flow from one topic to related topics Related: #969 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 1e2a4e2 commit e851197

5 files changed

Lines changed: 102 additions & 4 deletions

File tree

docs/concepts/index.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,34 @@
11
Concepts
22
========
33

4+
Understanding how fromager works under the hood.
5+
6+
Key Topics
7+
----------
8+
9+
These guides explain the fundamental concepts and design principles behind fromager:
10+
11+
* **Bootstrap vs Build Modes** - Understand the difference between recursive discovery (bootstrap) and single-package builds (build)
12+
* **Dependency Types** - Learn about build-system, build-backend, build-sdist, and install dependencies
13+
414
.. toctree::
515
:maxdepth: 1
616

717
bootstrap-vs-build
818
dependencies
19+
20+
Related Practical Guides
21+
-------------------------
22+
23+
Apply these concepts with task-oriented guides:
24+
25+
* :doc:`/using` - Bootstrap and build mode usage
26+
* :doc:`/how-tos/repeatable-builds` - Use build graphs for consistent builds
27+
* :doc:`/how-tos/graph-commands/index` - Analyze dependency graphs
28+
* :doc:`/customization` - Customize the build process
29+
30+
Reference Material
31+
------------------
32+
33+
* :doc:`/reference/glossary` - Definitions of key terms
34+
* :doc:`/reference/files` - Build order and graph file formats

docs/customization.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -474,3 +474,22 @@ def mycommand(
474474
) -> None:
475475
...
476476
```
477+
478+
## See Also
479+
480+
**Reference Documentation:**
481+
482+
* [Configuration Reference](reference/config-reference.rst) - Complete settings schema
483+
* [Hooks Reference](reference/hooks.rst) - Override plugin documentation
484+
* [CLI Reference](reference/cli.rst) - Command-line options
485+
486+
**How-To Guides:**
487+
488+
* [Override pyproject.toml](how-tos/pyproject-overrides.rst) - Modify build configuration
489+
* [Build from Git](how-tos/build-from-git-repo.rst) - Use custom source repositories
490+
* [Multiple Versions](how-tos/multiple-versions.rst) - Handle version conflicts
491+
492+
**Concepts:**
493+
494+
* [Bootstrap vs Build](concepts/bootstrap-vs-build.rst) - Understand build modes
495+
* [Dependencies](concepts/dependencies.rst) - Dependency types and resolution

docs/getting-started.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,3 +118,24 @@ The output below is redacted for brevity. Missing sections are replaced with ``.
118118
As each dependency is built, fromager will show output from the build process
119119
and progress information. At the end of the build, fromager shows the list of
120120
packages that were built and how long each step took.
121+
122+
Next Steps
123+
----------
124+
125+
Now that you understand the basic workflow and debugging process:
126+
127+
**Improve Your Workflow:**
128+
129+
* :doc:`how-tos/containers` - Run builds in containers for better isolation
130+
* :doc:`how-tos/bootstrap-constraints` - Pin versions for reproducible builds
131+
* :doc:`how-tos/repeatable-builds` - Use previous build graphs for consistency
132+
133+
**Customize Builds:**
134+
135+
* :doc:`customization` - Add patches, override settings, configure variants
136+
* :doc:`how-tos/pyproject-overrides` - Override pyproject.toml settings
137+
138+
**Learn How It Works:**
139+
140+
* :doc:`concepts/index` - Understand bootstrap mode, build isolation, and more
141+
* :doc:`reference/glossary` - Definitions of key terms

docs/quickstart.rst

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,21 @@ The ``-c`` option ensures fromager uses exactly the versions you specify.
7676
Next Steps
7777
----------
7878

79-
Now that you've seen fromager work with a simple package, you might want to:
79+
Now that you've seen fromager work with a simple package, explore:
8080

81-
* Learn to debug build failures with a more complex example in :doc:`getting-started`
82-
* Customize builds with settings, patches, and variants in :doc:`customization`
83-
* Check specific guides in :doc:`how-tos/index`
81+
**Learn More:**
82+
83+
* :doc:`getting-started` - Detailed walkthrough with debugging examples
84+
* :doc:`concepts/index` - Understand how fromager works
85+
86+
**Common Tasks:**
87+
88+
* :doc:`how-tos/containers` - Run fromager in containers (recommended)
89+
* :doc:`how-tos/bootstrap-constraints` - Pin versions for reproducible builds
90+
* :doc:`how-tos/repeatable-builds` - Ensure consistent builds across environments
91+
92+
**Customize Builds:**
93+
94+
* :doc:`customization` - Comprehensive customization guide
95+
* :doc:`reference/config-reference` - Configuration reference
96+
* :doc:`how-tos/index` - Task-oriented guides

docs/using.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,3 +252,22 @@ The `step build-wheel` command creates a wheel using the build
252252
environment and prepared source, compiling any extensions using the
253253
appropriate override environment settings (refer to
254254
[customization](customization.md) for details about overrides).
255+
256+
## See Also
257+
258+
**Understanding Build Modes:**
259+
260+
* [Bootstrap vs Build](concepts/bootstrap-vs-build.rst) - Detailed comparison of build modes
261+
* [Dependencies](concepts/dependencies.rst) - How dependency resolution works
262+
263+
**How-To Guides:**
264+
265+
* [Bootstrap with Constraints](how-tos/bootstrap-constraints.rst) - Pin versions for reproducible builds
266+
* [Repeatable Builds](how-tos/repeatable-builds.rst) - Use build graphs for consistency
267+
* [Parallel Builds](how-tos/parallel.rst) - Speed up builds with parallelization
268+
* [Build Web Server](how-tos/build-web-server.rst) - Serve built packages
269+
270+
**Reference:**
271+
272+
* [CLI Reference](reference/cli.rst) - Complete command documentation
273+
* [Files Reference](reference/files.md) - Build order and graph file formats

0 commit comments

Comments
 (0)