Inconsistent styling and lack of cross project navigation in Nix documentation
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
Observations
https://nix.dev/reference/nix-manual
and the nixpkgs and NixOS manuals and nix.dev don't have any navigation links between them or consistent styling.
related discussion https://logs.nixos.dev/room/!avYyleMexqjFHoqrME:nixos.org/?anchor=$1a-p0jIFGfppHqFadSnQIpoX40mUALH9qt7griX9qWk&offset=-10
Problem
The docs appear disjoint and not obviously under the umbrella of a unified team, and not obviously official.
Approaches
We could rectify this first with the baby step of a global navigation bar on nix.dev and nix docs without restyling the sites and go from there.
Willing to help?
Maybe, unsure exactly how to approach since the stuff is all separate unrelated code bases at present.
Priorities
Add 👍 to issues you find important.
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 comparing the navigation and styling of nix.dev, the Nix manual, and the nixpkgs and NixOS manuals, then read the linked discussion for context. A first milestone is a consistent global navigation bar linking the documentation sites; broader styling consistency would need an agreed scope across the separate codebases.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100