Explain the documentation architecture
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
Observations
Some contributors are skeptical about the nix.dev separation.
It would be nice for that information to be discoverable, and easy for anyone (but especially us) to refer to.
Problem
We might have to repeat this, and some might not even ask.
Approaches
Willing to help?
As a reviewer.
I did not come up with the policy and do not feel very strongly about it.
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 with the linked nixpkgs discussion and review the existing nix.dev documentation architecture. Clarify the rationale for the separation and identify where that explanation should be discoverable; the work is done when contributors can easily find and refer to the documented policy.
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
- 30/100