Create FAQ-like documentation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
I've been thinking it'd be good to pull together a document that contains info on / pointers to commonly discussed/referenced topics that seem to pop up regularly in GH issues, Discord, etc.
Some suggested items an FAQ-like doc could speak to (or have links/pointers to for things documented elsewhere):
- Strategies for incrementally adopting rustfmt in existing projects
- Disabling rustfmt/preventing rustfmt from running in a project
- config option stabilization process
- relationship between rustfmt & cargo fmt
- perhaps the versioning strategy for rustfmt?
Thoughts?
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 surveying the existing rustfmt documentation and the commonly referenced material in GitHub issues and Discord. Define an FAQ-like document covering incremental rustfmt adoption, disabling rustfmt, config-option stabilization, the rustfmt and cargo fmt relationship, and versioning, with links or pointers where topics are documented elsewhere. Done means the recurring questions have clear answers or useful references.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100