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

Feat/link validator #1395

Merged
merged 14 commits into from
Aug 22, 2023
Merged

Feat/link validator #1395

merged 14 commits into from
Aug 22, 2023

Conversation

lorenzolewis
Copy link
Member

@lorenzolewis lorenzolewis commented Aug 15, 2023

Currently just keeping as a draft while some upstream issues are worked through.

Upstream issues:

There may be additional issues with typedoc-plugin-markdown that I noticed in the output. One example is this link:

/2/reference/core/js/Namespace.event.md#windowlabel

It should instead be in this format:
/2/reference/core/js/namespaceevent#windowlabel

It could be another issue that I haven't had time to fully dig into yet, so I'll see what I can come up with on that.

Signed-off-by: Lorenzo Lewis <[email protected]>
Signed-off-by: Lorenzo Lewis <[email protected]>
Signed-off-by: Lorenzo Lewis <[email protected]>
Signed-off-by: Lorenzo Lewis <[email protected]>
@netlify
Copy link

netlify bot commented Aug 15, 2023

Deploy Preview for tauri-docs-starlight ready!

Name Link
🔨 Latest commit 26db038
🔍 Latest deploy log https://app.netlify.com/sites/tauri-docs-starlight/deploys/64e4c5f4ad46f40008407ade
😎 Deploy Preview https://deploy-preview-1395--tauri-docs-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@lorenzolewis
Copy link
Member Author

Got this one closer with the update from [email protected] (special thanks to @HiDeoo for that one)

Before:
Found 272 invalid links in 23 files.

After:
Found 254 invalid links in 20 files.

The remaining I think are due to an upstream issue in how links are generated that point to index.md files. I'll put an issue together to address that one in the morning.

Also noticed there's a few more typos in upstream APIs in Tauri I'll need to PR to get fixed.

@lorenzolewis
Copy link
Member Author

Looking into this more there are 2 issues I've found:

@lorenzolewis
Copy link
Member Author

Not an upstream issue, but HiDeoo/starlight-typedoc#14 covers the same problem that's happening here with {@link} not having it's URL generated correctly.

@lorenzolewis lorenzolewis marked this pull request as ready for review August 22, 2023 14:30
@lorenzolewis lorenzolewis merged commit 469d067 into next Aug 22, 2023
@lorenzolewis lorenzolewis deleted the feat/link-validator branch August 22, 2023 14:32
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.

1 participant