Reorganize docs
Open
Nobody has claimed this yet.
help wanted
- Dominant language
- JavaScript
- Stars
- 6.3k
- Forks
- 927
- PR merge metrics
- No merged PRs in 30d
Description
README.md should focus first (and most strongly) on using Sizzle, since it gets rendered into https://www.npmjs.com/package/sizzle . This includes API documentation currently in the wiki.
Remaining contents would be better placed in CONTRIBUTING.md and linked to from README.md.
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 README.md, CONTRIBUTING.md, and the API documentation in the linked wiki. Reorganize the material so README.md prioritizes using Sizzle and links to the remaining contributor-focused content; done means the npm-rendered README presents usage first and the other material has a clear home.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100