processing / processing/processing-website
Add links to Javadocs in reference pages
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 90
- Forks
- 122
- Avg merge
- 1h 43m
- Merged PRs (30d)
- 3
Description
Which area of the website does this enhancement relate to?
Reference
Describe the enhancement
In the previous version of the Processing website, each reference page linked to the relevant class or method in the Javadocs. These links are missing from the current site.
Why is this enhancement important?
Javadoc links are valuable for interested users who need more detailed information about the Processing API.
Additional context
Javadocs for Processing 4 are automatically generated at https://github.com/processing/processing4-javadocs
They are hosted on GitHub pages at https://processing.github.io/processing4-javadocs/
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is identified in the issue. Start by tracing how the Reference pages are generated and compare current pages with the Processing 4 Javadocs URL; done when each relevant class or method page exposes its corresponding Javadoc link.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100