Skip to content

add initial guide working_with_contributor_documents.md#8627

Open
nbogie wants to merge 2 commits intoprocessing:dev-2.0from
nbogie:nb-add-working-with-contributor-docs
Open

add initial guide working_with_contributor_documents.md#8627
nbogie wants to merge 2 commits intoprocessing:dev-2.0from
nbogie:nb-add-working-with-contributor-docs

Conversation

@nbogie
Copy link
Contributor

@nbogie nbogie commented Mar 9, 2026

Addresses #8619

Changes:
Add a new rough guide to working with contributor documents.

  • how to generate and preview them
  • how to add a new one


## 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants