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

Docs website broken links and false broken lnks #3916

Open
busma13 opened this issue Jan 23, 2025 · 0 comments
Open

Docs website broken links and false broken lnks #3916

busma13 opened this issue Jan 23, 2025 · 0 comments

Comments

@busma13
Copy link
Contributor

busma13 commented Jan 23, 2025

Broken links:
When typedoc creates the API docs it creates links to headings that are within the same file. If the file is docs/packages/<packageName>/api/foo/overview.md the link will look like [foo](overview.md#foo). When docusaurus transforms the markdown into html the link looks like this:

<a href="/teraslice/docs/overview#foo"><code>foo</code></a>

It doesn't recognize overview.md as a relative path and instead thinks it's an absolute path to the root overview.md file.

I've searched for some config that would clarify this, but haven't found anything yet.

False positives for broken links:
Docusaurus prints a giant list of broken links when you build the website. Most of these are false positives which makes finding the links that are actually broken very difficult. It would be great if we could find a way to fix all the false positives.

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

No branches or pull requests

1 participant