Per-project or Centralized User Documentation?
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 24.1k
- Forks
- 2k
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 365
Description
Hello, Uutils Team,
I’ve been browsing through the projects maintained under the @uutils organization, and I noticed a few things:
- Only
coreutilsandfindutilshave their own user documentation built with mdBook. - While
coreutils-docsis actively maintained, the last commit offindutils-docsis about 2 years ago. - The
book.tomlconfiguration forcoreutils-docsis titled "uutils Documentation". (Or just forgot it?)
Based on the above, I was wondering about the long-term plan for its user documentation:
- Per-project: Each project gets its own independent docs (e.g.,
coreutils-docs,findutils-docs, etc.). - Centralized: Gathering all projects into a single
uutils-docsuser documentation.
Which direction is @uutils heading?
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 reviewing the linked coreutils docs/book.toml and the existing coreutils-docs and findutils-docs documentation locations. Trace their maintenance status and compare the per-project and centralized options described in the issue. Done means the long-term documentation direction is decided and recorded for the affected projects.
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