processing
Making changes the the Reference content
The most frustrating thing I find with the reference area comes when using the back button. Like when I click on a function, I got to the functions page, but clicking back doesn't always take me back to the category anchor in reference for that function.
I am new to handlebars so struggling to make sence of how the reference page is constructed to even begin debugging that behaviour.
My 2nd issues regarding the reference system is updating/modifying the documentation. As I learn how the function work I think, gosh, if only it had said x in a paragraph or if it only had a link to related commands it would be so useful.
Again the learning curve of how the reference section is constructed with yaml and handlebars is holding me (and others i guess) from improving the documentation.
Could there be a p5 website github wiki to explain this in a bit more detail than the readme.md
Still going to keep trying to work this out as good intuitive documentation is such a useful think to have. I envy resources that export markdown to construct their reference documentation just because it's so much easier for almost anyone to write documentation in markdown and just put in a pull request.
Still any tips are most welcome.
thanks for the feedback. the information for modifying the reference documentation is here. let me know if you can think of places this link should be, so others can find it more easily.
one reason we keep the documentation in the source code is to couple the code with documentation. it makes it easier to update documentation as you're changing code, so you don't have to modify in two different places. additionally, there's a nice mechanism where our build process actually checks every reference example and definition against the source code, to make sure everything stays aligned.
it's also useful to us because it lets more people participate as code contributors. often, when people are new to contributing, I suggest that they start by fixing a typo in the documentation. in doing so, they go through the full library build and PR process and get to know it. then when they go on to make changes to other parts, they already have some sense of familiarity with it.
Found a fix for the autoscroll navigation issue, a chrome flag. chrome://flags/#enable-scroll-anchor-serialization
I've did a couple of pull requests, but struggling with git. (all commits go into the same pull request) is there a video on how to do this. Like showing how to fork, then download a copy of the fork to work on, then updating the fork and then doing a pull request. And is would doing branches make doing separate pull requests.
Answering my own question: via stack overflow...
Pull requests are based on a branch. The only way to open up a pull request for multiple commits is to isolate them into their own branch, and open the pull requests from there.
Will have to add making a video to my 2019 todo list :D
@hellonearthis check out section on branches here: https://guides.github.com/activities/hello-world/#branch