void-linux / void-linux/void-docs
Unify `xbps/repositories/signing.md` with `void-packages/README.md`?
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 217
- Forks
- 212
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 1
Description
https://github.com/void-linux/void-docs/pull/641 made me wonder if it's better to drop the section Signing Repositories and link to the README instead. Alternatively, drop the section in the README and link to the docs. Goal: not having duplicate documentation, which will probably lead to divergence in the future again.
But both "solutions" would make one document less self-contained... I don't really like either of them. But right now the README seems more of a "start to finish" guide without many links, so it's probably better to link from the docs to the README?
Another wild idea: Include the whole README into the docs, somewhere below 4. XBPS Package Manager. Not sure if that makes sense...
Maybe I'm just overthinking.
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
Compare xbps/repositories/signing.md with void-packages/README.md, and review void-linux/void-docs#641 for the related documentation change. Decide which single source should contain the signing guidance, then verify that the resulting documentation has no duplicated section and remains understandable to readers.
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