Documentation Style Guide suggestions
@nickmcintyre is already working on this.
Since Sep 22, 2023.
- Dominant language
- JavaScript
- Stars
- 24k
- Forks
- 3.8k
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 25
Description
Increasing Access
This a suggested restructuring of the Documentation Style Guide to give more emphasis to the goal of inclusivity and accessibility by moving the technical code style recommendations to a separate page.
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
- Internalization
- Friendly Errors
- Other (specify if possible)
Feature enhancement details
-
I think it might be helpful to separate the "Writing" and "Code Sample" styles into two separate pages. The code sample style suggestions are very good, but also very technical, and they take up a lot of page real estate which takes away from the main message of the "Writing" section, which is to emphasize inclusivity and accessibility.
-
Also, the Documentation Style Guide doesn't appear in the left navigation bar -- it seems to only have a link from the "Contributing Documentation" page.
(I was asked to look at this page by @nickmcintyre)
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.
Assessment
This issue has not been assessed yet.