uutils / uutils/coreutils

Per-project or Centralized User Documentation?

Open
#10,045 5 comments 0 reactions 0 assignees View on GitHub

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:

  1. Only coreutils and findutils have their own user documentation built with mdBook.
  2. While coreutils-docs is actively maintained, the last commit of findutils-docs is about 2 years ago.
  3. The book.toml configuration for coreutils-docs is titled "uutils Documentation". (Or just forgot it?)

Based on the above, I was wondering about the long-term plan for its user documentation:

  1. Per-project: Each project gets its own independent docs (e.g., coreutils-docs, findutils-docs, etc.).
  2. Centralized: Gathering all projects into a single uutils-docs user documentation.

Which direction is @uutils heading?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.