processing / processing/processing-website
Adding "Go to source" link to 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
Reference pages don't have any reference, connecting them to their source version in this repo. Let's say you want update a reference page, or simply fix a typo: https://processing.org/reference/frameCount.html While the change is only a single letter, because the website has no reference to https://github.com/processing/processing-website/blob/1fce63d07182becca614b95ab76b3b1416424d8d/content/references/translations/en/processing/frameCount.json , one should learn where the content is kept and search for the content in the repo.
Why is this enhancement important?
The lack of direct connection the presentation and source layer for reference docs makes the contribution process harder.
Additional context
No response
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
Start with the reference page for frameCount and the corresponding content/references/translations/en/processing/frameCount.json file. Trace how the reference page is presented, then determine where a source link belongs; the work is done when reference pages provide a direct link to their source content in this repository.
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
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100