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

documentation help wanted! #2865

Open
lmccart opened this issue May 9, 2018 · 66 comments
Open

documentation help wanted! #2865

lmccart opened this issue May 9, 2018 · 66 comments

Comments

@lmccart
Copy link
Member

@lmccart lmccart commented May 9, 2018

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
Copy link
Contributor

@m90 m90 commented May 9, 2018

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
Copy link
Contributor

@constanceyu constanceyu commented May 10, 2018

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
Copy link
Member Author

@lmccart lmccart commented May 10, 2018

@faithwyu that would be great!

@raulgrell
Copy link

@raulgrell raulgrell commented May 10, 2018

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
Copy link
Member Author

@lmccart lmccart commented May 10, 2018

@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
Copy link

@cecilebertin cecilebertin commented May 10, 2018

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

@lmccart
Copy link
Member Author

@lmccart lmccart commented May 10, 2018

👋@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
Copy link

@cecilebertin cecilebertin commented May 10, 2018

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

@cecilebertin
Copy link

@cecilebertin cecilebertin commented May 10, 2018

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

@lmccart
Copy link
Member Author

@lmccart lmccart commented May 10, 2018

@cecilebertin that makes sense to me

@cecilebertin
Copy link

@cecilebertin cecilebertin commented May 10, 2018

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

@raulgrell
Copy link

@raulgrell raulgrell commented May 10, 2018

@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
Copy link
Member Author

@lmccart lmccart commented May 10, 2018

@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
Copy link

@cecilebertin cecilebertin commented May 11, 2018

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
Copy link

@raulgrell raulgrell commented May 11, 2018

@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
Copy link
Member Author

@lmccart lmccart commented May 14, 2018

thanks everyone! 🙏 🙌 🎉

@lmccart lmccart closed this May 14, 2018
@lmccart lmccart reopened this Jun 15, 2018
@raulgrell
Copy link

@raulgrell raulgrell commented Jun 15, 2018

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
Copy link
Member Author

@lmccart lmccart commented Jun 22, 2018

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

@lmccart lmccart changed the title [mozsprint] documentation jam! documentation help wanted! Aug 13, 2018
@justinsunho
Copy link
Contributor

@justinsunho justinsunho commented Sep 26, 2018

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
Copy link

@mukulkhanna mukulkhanna commented Oct 19, 2018

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.

@ykabusalah
Copy link
Contributor

@ykabusalah ykabusalah commented Mar 26, 2020

I have some thoughts and would like your feedback if possible:

The asterisk-design-element on the https://p5js.org/get-started/ page causes an accessibility issue; the language controls are inaccessible to color blind users due to the colors of the asterix and the color of the languages. Either move the asterix below the language or change colors of the language bar on that page

  • The asterisk-design-element on the home page collides with the text and makes it hard to read, so move it to the bottom right corner
  • On the download-page the asterisk-design-element, on small screen sizes, the asterix collides with the nav, making it unusable; scale down the asterisk on that page to make this happen
  • On the reference page, same as above

@Rizz0S
Copy link
Contributor

@Rizz0S Rizz0S commented May 1, 2020

Could someone provide some guidance of what needs help with documentation rn? I really want to start contributing to the community, but most of the open issues right now are either already being worked on or out of my experience range. Thanks!

@montoyamoraga
Copy link
Sponsor Member

@montoyamoraga montoyamoraga commented May 7, 2020

thank you @Rizz0S, i think the most straightforward help to contribute,
instead of adding more documentation, would be to help us mantain the one we already have,
so i suggest going through the reference and examples, making sure that they don't have bugs,
and that they are written in a clear way :)

@samporapeli
Copy link
Contributor

@samporapeli samporapeli commented Sep 30, 2020

Hello 👋

I noticed a tiny incoherence in this reference page and decided to fix it (in a way that makes sense to me). I created a pull request draft #4817 and would appreciate if I could get some feedback on it :)

Best,
Sampo

lmccart added a commit that referenced this issue Oct 1, 2020
Change distance example to be more reasonable (addresses #2865)
@fal-works
Copy link
Contributor

@fal-works fal-works commented Jan 13, 2021

Just linking docs-related issues which i recently opened:
#4988
#4991

@shreyan-invalid
Copy link

@shreyan-invalid shreyan-invalid commented Feb 2, 2021

Hey if this issue is open I would like to contribute.

@lmccart
Copy link
Member Author

@lmccart lmccart commented Feb 2, 2021

hi @shreyan-invalid yes, you are welcome to work on this!

@Nolski
Copy link

@Nolski Nolski commented Feb 18, 2021

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
Copy link
Member Author

@lmccart lmccart commented Feb 18, 2021

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 hello@p5js.org and it will come through to me.

@AndrewAung11
Copy link

@AndrewAung11 AndrewAung11 commented Feb 19, 2021

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.
image

@lmccart
Copy link
Member Author

@lmccart lmccart commented Feb 22, 2021

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

@LouisJustinTALLOT
Copy link

@LouisJustinTALLOT LouisJustinTALLOT commented Mar 2, 2021

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

@limzykenneth
Copy link
Member

@limzykenneth limzykenneth commented Mar 7, 2021

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
Copy link
Contributor

@two-ticks two-ticks commented Mar 7, 2021

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

@lmccart
Copy link
Member Author

@lmccart lmccart commented Mar 9, 2021

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
Copy link
Contributor

@two-ticks two-ticks commented Mar 12, 2021

Are these meant to be links ?

image

@myloooon
Copy link

@myloooon myloooon commented May 8, 2021

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

@ghgsnaidu
Copy link

@ghgsnaidu ghgsnaidu commented May 14, 2021

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
Copy link

@thinklikeadesigner thinklikeadesigner commented Jul 8, 2021

I would like to help!

@cystark
Copy link

@cystark cystark commented Oct 18, 2021

Hello would love to contribute~

@lmccart lmccart pinned this issue Nov 12, 2021
@lmccart lmccart unpinned this issue Nov 12, 2021
@prakhar3062
Copy link

@prakhar3062 prakhar3062 commented Feb 2, 2022

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

@Manan17
Copy link

@Manan17 Manan17 commented Feb 10, 2022

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

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