prominently show revision date and history
Open
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
(the suggestion is based on my experience with the existing documentation that is spread over multiple places and not a comment on the this book project.)
To evaluate if information is valid (current best practice) it is helpful to know (while reading the documentation) when it is written.
Therefore I recommend:
- The nixos-wiki should show the date when a page was last edited.
- The sections in the (nix, nixpkgs, nixos) books should show a date when the source file was last edited.
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
Review the two targets named in the issue: last-edited dates for nixos-wiki pages and source-file dates for sections in the nix, nixpkgs, and nixos books. Trace how these pages and sections are presented, then verify that both types visibly show their revision dates and that the requested history is available.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100