Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix url paths and inline html character bugs on Foundation section of reference page content #522 #525

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

meganmckissack
Copy link

Addresses #522

Some of the summary descriptions show double characters when using operators like > and >=. Also, when clicking through to the full-page reference for these operators, the internal reference urls direct to 404 error pages since they are using the operator symbols rather than the new page url initials.

Character doubling
Before
Screenshot 2024-09-07 at 5 39 16 PM
Screenshot 2024-09-07 at 5 51 44 PM

After
Screenshot 2024-09-07 at 5 41 46 PM
Screenshot 2024-09-07 at 5 52 47 PM

URL change
Before
Screenshot 2024-09-07 at 5 55 25 PM

After
Screenshot 2024-09-07 at 5 56 30 PM

@meganmckissack
Copy link
Author

After opening this pull request, this comment on #522 mentions that the character doubling may be coming from a different source that I'll look into.

The failing tests are mention the same {rewriteRelativeLink} import referenced in issue #524. I don't know if it is what's causing the failed tests or because I manually changed the url paths in the mdx files yet.

@Qianqianye
Copy link
Collaborator

Hi @meganmckissack, thanks for opening this PR. The reference pages are built directly from the p5.js library src folder, so we will need to edit the source code directly to fix the links.

I noticed that there might be some bugs rendering and showing the source code links (at the bottom of the reference pages) within the following pages:

  • > (showing as '&gt'),
  • >=(showing as '>='),
  • < (showing as '&lt'),
  • <= (showing as '<='),

@nickmcintyre @limzykenneth @davepagurek, do you have any thoughts on this? Thank you.

@limzykenneth
Copy link
Member

For rendering in the page I'm not sure if Astro or the current build automatically encodes the characters so we need to check there first. For URL, adding a step to encode the URL path may be enough to solve this without needing to change the reference in the main p5.js repo.

@meganmckissack meganmckissack marked this pull request as draft September 11, 2024 16:50
@Qianqianye
Copy link
Collaborator

Thanks @limzykenneth.
This PR is related to issue #538 and #447 (comment), which are about rendering symbols and characters (for example "<>" ) on reference page. To keep the discussion organized and consolidated, let's continue the discussion within issue #447. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants