improve navigation across different documentation resources
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
It is difficult to find information across the different layers of documentation
(the suggestion is based on my experience with the existing documentation that is spread over multiple places and not a comment on the current book project.)
I see the value to keep separate books, but this separation of concern should be balanced with an effort to link between the different documents.
Therefore I suggest:
- Add more links between the books and the wiki.
- Make use of paged documentation in the NixOS and nixpkgs manuals, as used in the nix manual, so that at the bottom of each section is space for links.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing books, wiki, and the nix manual's paged documentation pattern. Map where cross-links and section-level navigation are currently missing. Done would mean an agreed, consistent navigation approach applied across the documentation resources, but the issue does not identify files or a defined scope.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100