Skip to content

moving syntax to the top of the reference pages #542

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

Open
tegacodes opened this issue Sep 13, 2024 · 6 comments
Open

moving syntax to the top of the reference pages #542

tegacodes opened this issue Sep 13, 2024 · 6 comments

Comments

@tegacodes
Copy link

Increasing Access

It would make the syntax more prominent and easier to find for beginners.

Most appropriate sub-area of p5.js?

Reference

Feature request details

Hey y'all, really great job on the new site. It looks great. I think moving the syntax for each function to the top of each function page would make it easier to find. The p5 reference is often used to check syntax and having to scroll down the page and look for it can be time consuming.

@computationalmama
Copy link
Contributor

Yes you are right something like the old website would be great. I've often found that it was easier to refer through it.
Did you mean like this one @tegacodes?

Screenshot 2024-09-24 at 12 39 25 AM

@limzykenneth
Copy link
Member

@tegacodes Only just came across this but I think what you mean is similar to what is mentioned in #582?

What I'm thinking is that people copy more often from the example for an immediately working code instead of the syntax definition, but maybe I'm wrong on this impression?

@davepagurek
Copy link
Collaborator

davepagurek commented Oct 15, 2024

I'm sympathetic to putting the syntax at the top personally, I end up scrolling to the bottom most of the time. This is especially for functions like image() where the examples have a bunch of numbers and I'd like to see the names of the parameters to more easily differentiate between them. Not sure how common that is for other people though, so I don't have a super strong opinion on this.

@computationalmama
Copy link
Contributor

What I was thinking:

For the main page: https://p5js.org/reference/

  • All features on top gives creators a sense about the possibilities (for new creators)
  • For returning creators/coders who just want a quick reference

I'd love for it to be a bit more inviting to folks who are exploring and pushing their p5js journey forward!

I end up scrolling to the bottom most of the time.

Like @davepagurek I too find that I have to scroll way down, but I don't mind it so much in on the internal pages: https://p5js.org/reference/p5/circle/

@limzykenneth
Copy link
Member

We can possibly set up A/B testing for more evidence for either case but the setup of which probably would be a bit complicated, serving the two versions I can do it relatively easily with Cloudflare Workers but the data collection probably need a bit more.

@computationalmama
Copy link
Contributor

Cool! If it saves you some cycles @limzykenneth we could just ask a few folks in different groups? Don't know if that's a reasonable way to think about this stuff 🤔

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