Positioning of the "Scope" is too late in the document
Open
Nobody has claimed this yet.
editorial
ready-for-PR
- Dominant language
- Shell
- Stars
- 112
- Forks
- 38
- Avg merge
- 12d 19h
- Merged PRs (30d)
- 4
Description
"4. Scope" describes what is explained in this document. It is better to have it earlier in the document, probably right after the Introduction.
That way, readers can grasp what this document is about at the outset.
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 locating the document's Introduction and the current “4. Scope” section. Move Scope immediately after the Introduction, then confirm that the document structure and section numbering remain coherent.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100