processing / processing/p5.js-website

Links in Parameters section don't work

Open
#674 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Most appropriate sections of the p5.js website?

Reference

What is your operating system?

Linux

Web browser and version

Google Chrome 131.0.6778.204 (Official Build) (64-bit)

Actual Behavior

I believe that links in the Reference are auto-generated from the Javascript comments. Links in the description of the function work, but links in the Parameters section do not.

For example, on the Text page:

Expected Behavior

Links in the Parameters section should correctly link to other pages, as in the rest of the reference page.

Steps to reproduce

No response

Would you like to work on the issue?

Sure, I can work on this if someone can point me to where this is configured or generated

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 Text page and trace how links are generated from JavaScript comments, comparing the working description link with the broken Parameters link. Verify that a Parameters link to rectMode() resolves to the rectMode reference page rather than an anchor under Text, then check the affected reference output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.