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

Rephrase reference page subtitle #1354

Open
limzykenneth opened this issue Apr 14, 2023 · 4 comments
Open

Rephrase reference page subtitle #1354

limzykenneth opened this issue Apr 14, 2023 · 4 comments

Comments

@limzykenneth
Copy link
Member

Increasing Access

Rephrasing the subtitle that currently mentions p5.Sound can help clarify possible next steps for new contributors.

Most appropriate sub-area of p5.js?

Reference

Feature request details

Currently the subtitle of the reference page says "Can't find what you're looking for? You may want to check out p5.sound.", we think it would be helpful to include links to Github Issues, Contributor Documentations, and also making p5.Sound have its own category.

PS. Filed by OSACC p5.js Github Issues Working Group

@Qianqianye
Copy link
Contributor

Thanks @limzykenneth. I am inviting @nickmcintyre (who's working on the reference page for SoD) and @montoyamoraga (who's the p5.sound fellow this year) to this discussion.

@montoyamoraga
Copy link
Member

hey :)

i propose something along the lines of:

Here is the complete reference of all functions and variables available on p5.js.
Can't find what you're looking for? Please check out our Github Issues, Contributor Documentations, etc.
Please note that p5.sound.js has its own reference page here
You can also download an offline version of the reference.

@nickmcintyre
Copy link
Member

Thanks for including me in the discussion. Here's my first draft:

Documentation for libraries including p5.sound lives on the Libraries page. If you'd like to contribute to the p5.js documentation, check out our getting started guide. You can also download an offline version of the reference.

The Reference page has a lot of content at the moment. Adding the full p5.sound API may overwhelm people.

@Qianqianye
Copy link
Contributor

Thanks @montoyamoraga and @nickmcintyre. Below is version combining you two's input:

Can't find what you're looking for? Please open a Github Issue if you'd like to request a new feature. If you'd like to help with the p5.js documentation, check out the contributor docs. Please note that p5.sound.js has its own reference page here. You can also download an offline version of the reference.

What do you think? We can revisit the sentence about p5.sound after @montoyamoraga's p5.sound fellowship.

P.S. While @montoyamoraga is updating p5.sound and its documentation right now, I want to share that @nickmcintyre recently added a Documentation Style Guide for the Season of Docs project. I think it'd make sense for p5.sound to follow the same style guide when it comes write the reference documentation.

@Qianqianye Qianqianye added this to the 1.7.1 milestone Jul 14, 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