documentation help wanted!

[lmccart]

Hi 👋👋👋

We are using this issue to focus on documentation! Documentation is essential for new learners and experienced programmers alike. It helps make our community inclusive by extending a friendly hand to those that are less familiar with p5.js. It also helps us find the bugs and issues with the code itself, because we test and try things out as we document.

There are several ways to contribute, you can read more about them on this page.

If you are adding some documentation, please comment below. And don't forget to add yourself to the contributors list!

Welcome! We're so glad you're here!
❤️ the p5.js community

[m90]

For anyone who wants to work on adding missing examples and doesn't know where to start, this seems to be where there are still examples missing right now:

src/io/files.js:1329: method p5.save missing example
src/webgl/material.js:14: method p5.loadShader missing example
src/webgl/material.js:125: method p5.shader missing example
src/webgl/p5.Geometry.js:52: method p5.Geometry.computeFaces missing example
src/webgl/p5.Geometry.js:94: method p5.Geometry.computeNormals missing example
src/webgl/p5.Geometry.js:133: method p5.Geometry.averageNormals missing example
src/webgl/p5.Geometry.js:154: method p5.Geometry.averagePoleNormals missing example
src/webgl/p5.Geometry.js:247: method p5.Geometry.normalize missing example
src/webgl/p5.Shader.js:270: method p5.Shader.setUniform missing example

[constanceyu]

I would love to help out porting the tutorials from processing (https://processing.org/tutorials/) to p5. @lmccart I can work on more text based tutorials such as "typography" and "strings and drawing text" since I noticed they are still missing. Or do you have a particular one you would like me to start on first?

[lmccart]

@faithwyu that would be great!

[raulgrell]

I'm going through the processing.org examples - some of the stuff that is missing seems to address the language itself as opposed to the library. For example, processing.org talks about "Integers and Floats" and "Datatype Conversions". Should I make Javascript equivalent entries like "Numbers" and "Dynamic Types"?

[lmccart]

@raulgrell good question. not yet. we're not set up with the right website/reference infrastructure yet to be able to display those correctly.

[cecilebertin]

Hi, I'd like to work on porting the examples from the processing example page to the p5.js example page.

[lmccart]

👋@cecilebertin welcome! all the instructions for porting examples should be in the issue notes above. but let us know if you have any questions or encounter problems and we'll do our best to get back to you as soon as we can

[cecilebertin]

@lmccart I will start with porting the Data: Integers and Floats example.

[cecilebertin]

@lmccart Should I call this example Data: Numbers instead? Since there is only the Number datatype for numbers in JavaScript.

[lmccart]

@cecilebertin that makes sense to me

[cecilebertin]

Hi @lmccart, I made a pull request for the Numbers example.

[raulgrell]

@lmccart - I was trying to ask the same question as @cecilebertin, but I seem to have suffered a momentary lapse of eloquence =P

Unfortunately, that also means I'm not sure I understood your reply. Did you mean you don't yet have a way to show something like console output?

[lmccart]

@raulgrell oh! i'm sorry, i misread and thought you were talking about the processing reference entries where they have entries for "String" or "Float". now I have reread and realize you are referring to the examples page. yes, I think that makes sense to rename as you suggest!

[cecilebertin]

So sorry @raulgrell !! I didn't see you wanted to work on this. I only checked the issues in the processing/p5.js-website repository to check if someone was working on this example.

[raulgrell]

@lmccart @cecilebertin No worries, I could have been clearer! There are still more examples to do =)

I'll send a PR for Strings, and possibly something for Data Types as well that deals with type coercion and whatnot

[lmccart]

thanks everyone! 🙏 🙌 🎉

[raulgrell]

Oh dear, I completely forgot about this! That weekend I participated in a Game Jam where we actually used p5 to make a little neuroscience experiment disguised as a game and I never got round to finishing the examples... check it out: https://github.com/raulgrell/NeuroJam

Unfortunately, I've got a big presentation for uni on Monday and I won't be able to dedicate any time to this right now...

[lmccart]

thanks @raulgrell no worries. we'd welcome the additions anytime, no rush. thanks for sharing the game jab result, it's great!

[justinsunho]

Hi @lmccart, is #1954 an up to date list of examples we could take on? Or is there an active list of tutorials that could be worked on? Don't want to be re-doing anyone else's work/ work that's already been done.

[mukulkhanna]

For anyone who wants to work on adding missing examples and doesn't know where to start, this seems to be where there are still examples missing right now:

src/io/files.js:1329: method p5.save missing example
src/webgl/material.js:14: method p5.loadShader missing example
src/webgl/material.js:125: method p5.shader missing example
src/webgl/p5.Geometry.js:52: method p5.Geometry.computeFaces missing example
src/webgl/p5.Geometry.js:94: method p5.Geometry.computeNormals missing example
src/webgl/p5.Geometry.js:133: method p5.Geometry.averageNormals missing example
src/webgl/p5.Geometry.js:154: method p5.Geometry.averagePoleNormals missing example
src/webgl/p5.Geometry.js:247: method p5.Geometry.normalize missing example
src/webgl/p5.Shader.js:270: method p5.Shader.setUniform missing example

Can this be updated please? Thank you.

[Nolski]

Hi!
I'm working with W. Michelle Harris to help improve the experience of contributing learning materials for p5.js as a part of our Open Programs Office. We have a team of designers, technical writers, and developers to help us do this as well. Some things we were hoping to potentially help out with and contribute are:

• Developing an initial education plan and identifying gaps in what is provided by the p5.js website. It looks like there's work towards this already in this thread, we would hope to perhaps split it out into its own series of tickets or document depending on how the maintainers felt.
• Having out UX designers take a look at the learning section of the website and discuss/propose some changes
• Michelle has developed lots of course work around p5.js and we would like to contribute this to the existing library of learning resources.

@mcturner1995 What do you think of this? Happy to have a chat to see how we can best use our resources to make p5.js better without hindering anyone else's work.

[lmccart]

Hi @Nolski, this is wonderful! It would be very helpful to the project. I'd be happy to chat with you about this. I'm in an extreme zoom overload state these days, could we possibly discuss via email? You can write to [email protected] and it will come through to me.

[AndrewAung11]

I saw a space in the reference page under the foundation. But under other header I didn't see any space. Is it a bug or something else? Just letting you know.

[lmccart]

@AndrewAung11 yes this could be considered a bug. If you are interested in working on it, you are welcome to!

[LouisJustinTALLOT]

hi, I was considering starting a documentation in French. would anyone be interested ?

[limzykenneth]

Hi @LouisJustinTALLOT, I don't think there is a plan to add additional translations at this point, maybe it can be pitched as a GSoC or Fellowship project but that's not a decision I'm involved with. That's for official translations though, for unofficial translations we definitely welcome anyone to do it and publish on their own URL, you can then share that URL with us so we can list it as an unofficial translation.

On a not totally unrelated note, I'm working on some research into this area, if you are able to would you be interested in trying out some experiments I'll be working on? Basically I'm looking into the documentation translation process and possibly creating a software or workflow for translations that fits into the overall documentation process.

[two-ticks]

Hi, I'm new here. I want to contribute. Can I work on examples to write mathematical expressions using KaTeX in p5.js sketches?

[lmccart]

hi @two-ticks thanks for your interest! I would suggest looking at https://processing.org/examples/ and seeing if you can port any over to http://p5js.org/examples. I think there are several missing from the math categories right now.

[two-ticks]

Are these meant to be links ?

[myloooon]

Hi all! I'd love to contribute whatever would be most helpful right now. :)

[ghgsnaidu]

Hello !! I would like to contribute.
I have seen an example of bubble sort under maths section
,I would like to add other sorting algorithms as examples can I do that??

[thinklikeadesigner]

I would like to help!

[camyujistark]

Hello would love to contribute~

[prakhar3062]

I would love to contribute but need little more explanation where you wanted update

[Manan17]

I would love to contribute but need little more explanation where you wanted update

[Qianqianye]

Thanks @thinklikeadesigner @prakhar3062 @Manan17. You can take a look issues with label 'help wanted' or any open issues you'd like to work on, or read the contributing documentation if you want to know different ways of contributing.

[Qianqianye]

Thank you all for all your input on this issue. We are currently working on a project to reorganize and update the p5.js documentations. So I will close this issue for now to avoid confusion. We will revisit the issues labeled 'Documentation' or open a new issue about documentation helps we need later.

CC @limzykenneth @davepagurek @nickmcintyre