Versioning info on API docs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 24k
- Forks
- 3.8k
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 25
Description
Versioning info on reference pages
I think it would be useful to have a minimum version note on each API doc (each method/constant/class page on p5js.org/reference)
The only problem with this that I can see is that it might not be worth the work to go document it all. Its pretty easy to just tell people to use a cdn script tag with the latest version, and if the versions had to be figured out manually that could be a lot of work.
But there's a lot I don't know, so I'm opening this discussion!
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 the discussion and the API reference pages on p5js.org/reference, then determine how minimum versions would be established for each method, constant, and class. The issue does not name repository files or tests; done would mean an agreed approach and version notes across the reference pages, rather than simply documenting the latest CDN version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100