processing / processing-website

Repository for the processing.org website
https://processing.org
GNU General Public License v2.0
68 stars 94 forks source link

Fixed link on PFont resource page, file PFont.json #469

Closed SilasVM closed 1 year ago

SilasVM commented 1 year ago

This PR Fixes #468.

I corrected the link at the bottom of this page: https://processing.org/reference/PFont.html. Instead of going to: https://processing.org/reference/PGraphics_textFont_.html It now goes to: https://processing.org/reference/textFont_.html

Before:

BeforeLinkFix#468

After:

AfterLinkFix#468

Page: https://processing.org/reference/PFont.html

SableRaf commented 1 year ago

Hey @SilasVM,

Thanks for spotting that link issue on the PFont page! Just a quick heads-up: your PR was made to the processing-website repo, which isn't where we handle these types of updates. Instead, the Processing reference is updated by editing the Java source file comments in the processing4 repo. Comments that include the @webref tag are then picked up by a doclet script to generate the .json files. Remember to use the @see tag for related links in JavaDoc comments. Next time we run the doclet script, the .json will reflect the changes. More on that in processing-website/docs/reference.md.

If the problem's from the doclet script itself, this could indicate a broader problem affecting more than just this single reference page. Here's the doclet script's README for reference.

I'll need to close this PR since it's targeting the wrong repo. But we'd really appreciate it if you could direct your efforts either towards adjusting comments in the processing4 repo or investigating the processing-doclet if you suspect an issue there.

Appreciate your help with Processing's docs!

Cheers, Raphaël