Task: create a contributing guideline for documentation
Open
Nobody has claimed this yet.
guide
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
In order for contributors to write new material more effectively, add a lightweight guideline for creating (and reviewing) contributions to documentation.
What:
- make sure the documentation category is chosen appropriately
- for tutorials: https://nix.dev/contributing/writing-a-tutorial
- make sure new material is placed sensibly:
- check the writing guides:
- make sure you understand what the new/changed documentation tries to tell you
- user testing is one thing, the reviewer can also play the role of a new user
Where to put it:
- https://nix.dev/contributing/documentation#guidelines
- expand this section by prepending the instructions
- move list of available documentation and communication channels into a sub-file
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 documentation guidelines section at nix.dev/contributing/documentation and read CONTRIBUTING.md to understand placement conventions. Add the contribution and review guidance there, and move the documentation and communication channels list into a sub-file; done means the guidelines are discoverable and the existing links remain usable.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100