add initial guide working_with_contributor_documents.md#8627
add initial guide working_with_contributor_documents.md#8627nbogie wants to merge 4 commits intoprocessing:dev-2.0from
Conversation
|
|
||
| ## Build process overview | ||
|
|
||
| During the website build process `build:contributor-docs`, the documents are cloned from the requested branch of the p5.js repo into the relevant website file-system locations. |
There was a problem hiding this comment.
Thanks for this! Since we're working in 2 locations I think for any CLI commands, please include where it should be run. Eg, WDYT about style that states what/where is run, and then explains:
In p5.js-website repo, running npm .... will clone the documents from the requested branch of the p5.js repo into the relevant website file-system locations.
Does that seem like a reasonable pattern to try here?
There was a problem hiding this comment.
Yes, good spot, thanks! Locations for commands are covered in the full instructions in the section "Preview on local p5.js-website clone" but it bears either repeating in the summary, or not mentioning the command in the summary so that the reader doesn't take away only that piece of information without the rest of the context.
Continuous ReleaseCDN linkPublished PackagesCommit hash: 80caf48 Previous deploymentsThis is an automated message. |
| * open the command-palette (`F1` or `cmd-shift-p` or `ctrl-shift-p`) | ||
| * type `Markdown: open preview` | ||
|
|
||
| <!-- TODO: list limitations of this quick-preview approach: e.g.the website styling (including line width) will not be applied. --> |
There was a problem hiding this comment.
@nbogie This still has some TODOs - did you want to address these before merge? Or keep as placeholder? I think otherwise it's very helpful already, let me know if it's blocked anyhow
2 participants
Addresses #8619
Changes:
Add a new rough guide to working with contributor documents.