processing / processing/p5.js-website

moving syntax to the top of the reference pages

Open
#542 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Feature Request
Dominant language
MDX
Stars
96
Forks
322
Avg merge
5d 22h
Merged PRs (30d)
8

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the p5.js Reference function pages and identify how their syntax sections are assembled. Move the syntax content to the top of each function page, then verify that the syntax is easier to find and remains correct across the reference pages.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.