Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit typography docs to align with style guide #6449

Closed
1 of 17 tasks
nickmcintyre opened this issue Sep 30, 2023 · 8 comments
Closed
1 of 17 tasks

Edit typography docs to align with style guide #6449

nickmcintyre opened this issue Sep 30, 2023 · 8 comments

Comments

@nickmcintyre
Copy link
Member

Increasing Access

Writing with plain, consistent language increases cognitive accessibility. It's also more welcoming to younger members of the community.

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'll edit the inline documentation and code samples for each function in the typography group.

@thinley4
Copy link

thinley4 commented Oct 1, 2023

Hey @nickmcintyre can i work on this issue ?

@nickmcintyre
Copy link
Member Author

nickmcintyre commented Oct 1, 2023

Sure @EarthIsHeaven! The more eyes we have on these edits the better. How about reviewing my most recent pull request to get started?

Here's how I build and test documentation locally. This workflow assumes you have git and nvm installed on macOS or Linux.

# Install the LTS version of node and use it.
nvm install --lts
nvm use --lts

# Make a folder for docs and navigate to it.
mkdir docs && cd docs

# Clone Nick's fork of the p5.js repo.
git clone https://github.com/nickmcintyre/p5.js

# Clone the p5.js-website repo.
git clone https://github.com/processing/p5.js-website

# Navigate to the p5.js directory.
cd p5.js
# Check out the branch under review.
git checkout sod-typography-load-display
# Generate data for the API reference.
npm install
npx grunt lint:samples

# Navigate to the p5.js-website directory.
cd ../p5.js-website
# Copy data for the API reference.
cp ../p5.js/docs/reference/data* src/templates/pages/reference
# Build a draft of the website.
npm install
npm run build

# Navigate to the directory with the built website.
cd dist
# Serve the website on localhost:8000.
python3 -m http.server

@skbhagat0502
Copy link

Hi @nickmcintyre I am working on this issue.

@nickmcintyre
Copy link
Member Author

@skbhagat0502 thanks for offering to help out! I'll make another pull request with edits soon and will tag you to review.

@skbhagat0502
Copy link

Hey @nickmcintyre Can I make pull request or I can just help you by reviewing it as I have also made some changes to the textAlign docs. If you agree then I will make a pull request.

@nickmcintyre
Copy link
Member Author

@skbhagat0502 I could really use your help with reviews. It's my job to edit the entire API reference through the end of the year. I'd love to incorporate any feedback you may have!

@harshsharma-11
Copy link

@skbhagat0502 @nickmcintyre @EarthIsHeaven is there any community channel of processing like slack or something

@nickmcintyre
Copy link
Member Author

nickmcintyre commented Oct 3, 2023

@harshsharma-11 yep! There's a p5.js Discord and Processing Discourse.

@nickmcintyre nickmcintyre moved this from In Progress to Done in p5.js Season of Docs Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

4 participants