Skip to content

chore(script-native): convert JSDoc links to Markdown links #4099

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

Merged
merged 1 commit into from
May 1, 2025

Conversation

thetaPC
Copy link
Contributor

@thetaPC thetaPC commented May 1, 2025

Issue URL: N/A

What is the current behavior?

Pages under the /native are auto-generated based on the packages' latest README. The docs site has no way to override the contents as any changes would be immediately removed upon start or build.

Docusaurus will throw parse errors when using {@link URL|Text} or {@link URL}.

What is the new behavior?

There's been a recent README update to the @capacitor/google-maps that used JSDoc links. This caused Docusaurus to throw a parse error, leading to the docs site to not build or start.

Updated the native script to automatically convert any JSDoc links to MD links.

Does this introduce a breaking change?

  • Yes
  • No

Other information

v8 Preview
v7 Preview

How to test:

  1. Navigate to the previews
  2. Verify the links under the Position section render correctly

Copy link

vercel bot commented May 1, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
ionic-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 1, 2025 4:05pm

@thetaPC thetaPC marked this pull request as ready for review May 1, 2025 16:12
@thetaPC thetaPC requested a review from a team as a code owner May 1, 2025 16:12
@thetaPC thetaPC requested a review from brandyscarney May 1, 2025 16:12
Copy link
Member

@ShaneK ShaneK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, great fix!

@thetaPC thetaPC merged commit 89ba552 into main May 1, 2025
4 checks passed
@thetaPC thetaPC deleted the native-script branch May 1, 2025 16:24
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.

2 participants