(2.0) Document how to generate and preview contributor docs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 24k
- Forks
- 3.8k
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 25
Description
Increasing access
Better documentation in this area would make it easier for more people to add or edit contributor docs.
Most appropriate sub-area of p5.js?
- Accessibility
- Color
- Core/Environment/Rendering
- Data
- DOM
- Events
- Image
- IO
- Math
- Typography
- Utilities
- WebGL
- Build process
- Unit testing
- Internationalization
- Friendly errors
- Other (specify if possible)
Feature enhancement details
initial changes
Add a document in contributor_docs/ which details:
- how to build and preview changes to the contributor docs
- how to troubleshoot this process
possible eventual additions
Whilst out of scope of this first issue, eventually thesame guide might also cover:
- how to add a new contributor doc
- where source copies of contributor docs live
- filename conventions
- eventual URL paths
- title - first level 1 heading
- subtitle - first line html comment
- how to link to other docs and reference pages
- how to include assets (images, etc)
- link to markdown guide
- style guidelines, or, links to relevant sections of https://beta.p5js.org/contribute/documentation_style_guide/
name:
I was thinking working_with_contributor_documents.md. Perhaps just writing contributor_documents.md is preferred?
Other 2.0 contributor doc filenames for context:
access.md
contributing_to_the_p5js_reference.md
contributor_guidelines.md
creating_libraries.md
documentation_style_guide.md
fes_contribution_guide.md
friendly_error_system.md
how-to-add-friendly-error-messages.md
p5.strands.md
release_process.md
steward_guidelines.md
unit_testing.md
web_accessibility.md
webgl_contribution_guide.md
webgl_mode_architecture.md
webgpu.md
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 examining the contributor_docs/ directory and the repository's existing documentation and build process. Document how to build, preview, and troubleshoot contributor docs, keeping the broader guidance on authoring new documents out of scope. Done means a new contributor can follow the guide to preview documentation changes and recover from common problems.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100