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

Clarity improvements for wiki page #6506

Closed
1 of 17 tasks
matthewlee01 opened this issue Oct 28, 2023 · 8 comments
Closed
1 of 17 tasks

Clarity improvements for wiki page #6506

matthewlee01 opened this issue Oct 28, 2023 · 8 comments

Comments

@matthewlee01
Copy link

Increasing Access

Hi, I was recently getting started with learning p5.js and noticed 2 small clarity issues on this wiki page: https://github.com/processing/p5.js/wiki/Local-server

  1. The "Node http-server" heading is incorrectly formatted as a subheading.
  2. The instruction directing readers to the "lightning bolt" icon should be annotated with an emoticon (⚡️) to match the formatting of the rest of the page, as well as improving clarity for readers using a page translator.

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

When skimming through this documentation, I initially missed the node.js option because it was formatted as a subheading; then once I saw it I was confused and interpreted it as a sub step of the previous Python section.

The emoticon/icon is just nice polish to keep the page more cohesive (see the other emoticon usage in the same page) and accessible.

@welcome
Copy link

welcome bot commented Oct 28, 2023

Welcome! 👋 Thanks for opening your first issue here! And to ensure the community is able to respond to your issue, please make sure to fill out the inputs in the issue forms. Thank you!

@nickmcintyre
Copy link
Member

nickmcintyre commented Oct 28, 2023

Thanks for pointing these out @matthewlee01! We'll incorporate your suggestions in the next iteration of this page. It'll be updated and merged with a few others over the coming months.

@Garima3110
Copy link
Member

Also, @nickmcintyre I would like to point out that the link for cloning its repository doesn't work .

Link : https://github.com/processing/p5.js.wiki.git

Please let me know if a separate issue should be opened for this?!
Thankyou!!

@nickmcintyre
Copy link
Member

@Garima3110 give git clone https://github.com/processing/p5.js a try. Here are our contributor guidelines with more detailed info for different ways to contribute.

@Garima3110
Copy link
Member

Garima3110 commented Oct 30, 2023

@Garima3110 give git clone https://github.com/processing/p5.js a try. Here are our contributor guidelines with more detailed info for different ways to contribute.

@nickmcintyre ,I think you got me wrong, actually the wiki page had a clone link to contribute to that page, I copied the same link and didn't work.

Screenshot of the same:

image

So ,I just wanted to know whether an issue should be opened for this or not?!
Also @Qianqianye what's your take on this?!
It would be very helpful if you could respond to this.
Thankyou!

@nickmcintyre
Copy link
Member

@Garima3110 ohh gotcha. Have you tried git clone https://github.com/processing/p5.js.wiki.git? I just tested it on macOS and Linux.

We'll probably archive the wiki soon as part of a larger project to make the p5.js documentation more accessible. Most of the content will find a new home in the repo and/or on the website.

@Garima3110
Copy link
Member

@nickmcintyre ,Thanks for your response.
Here is the screenshot of trying git clone https://github.com/processing/p5.js.wiki.git on windows.

Also, on checking status ,its just showing some deleted files.

image

@limzykenneth
Copy link
Member

The wiki is not publicly editable and the relevant changes have been made. There is a rewrite of Wiki contents currently in the works so there's no plan to accept changes proposals for the Wiki for the moment. Thanks.

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

No branches or pull requests

4 participants