draft: updating contributing_to_the_p5js_reference for v2 #8462
+357
−88
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
i.e. update the document contributing_to_the_p5js_reference Add section on p5v1 -> p5v2 & yuidoc -> jsdoc add link to sin() in repo add links to jsdoc syntax for various tags mark all legal jsdoc comment blocks as js for markdown update the sin() doc comment example add more subheadings for the sections update description section update the params, return section, notably on constants start a syntax differences (v1->v2) appendix start a todo section with Qs - will remove before PR
* add experimental mermaid flow diagrams for * build:contributor-docs * search index generation * improve initial aside on versions
* link to the JSDoc best practices,doc * link to jsdoc @Property * break long paras * link to documentation style guide * mention optional text between examples * add sub-headings * add section on modernizr * covered assets, hotlinking, other v1-v2 differences * addded a placeholder edit on style guide
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #8454
WIP. This PR is meant only as an early draft for discussion, just now.
Changes:
TODO (there is some detail listed already in the commit messages)
Screenshots of the change:
TODO
PR Checklist
npm run lintpasses