jquery/sizzle

Reorganize docs

Open

#366 opened on Nov 11, 2015

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (6,264 stars) (991 forks)batch import
help wanted

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

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Markdown syntaxGit basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the current README.md and CONTRIBUTING.md files. Identify sections in README that are more about contributing (e.g., build instructions, testing) and move them to CONTRIBUTING.md. Then update README to focus on usage and link to the wiki for API documentation. Ensure links are updated.