Document semvar range syntax comprehensively on a single page
Open
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 712
- Forks
- 4.2k
- Avg merge
- 4d 16h
- Merged PRs (30d)
- 3
Description
I find documentation of semvar range syntax on multiple pages:
- https://docs.npmjs.com/about-semantic-versioning
- https://docs.npmjs.com/cli/v10/commands/npm-update#example
- https://semver.npmjs.com/#syntax-examples
- https://github.com/npm/node-semver (I'm not sure if this one should be considered in this conversation)
I don't mind overlap so long as a single comprehensive page exists. The problem is, each page contains unique content, so if you can't find the answer you're looking for on one page, you have to read the next.
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 comparing the semantic-versioning page, npm-update example, semver.npmjs.com syntax examples, and the node-semver repository referenced in the issue. Identify the unique range-syntax content across these sources and consolidate it into one comprehensive documentation page, while preserving or clarifying relevant links and examples.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100