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

Typedoc secondary entrypoints rendered on the docs hub #3037

Closed
petertonysmith94 opened this issue Aug 26, 2024 · 6 comments
Closed

Typedoc secondary entrypoints rendered on the docs hub #3037

petertonysmith94 opened this issue Aug 26, 2024 · 6 comments
Labels
bug Issue is a bug

Comments

@petertonysmith94
Copy link
Contributor

Summary

As part of the #2919 we added multiple entrypoints for typedocs. There are correctly not rendered as a navigation item within Vitepress, however, on the docs hub, these are being displayed as navigation items.

image

We should remove these items from being displayed as navigation items on the docs hub.

@danielbate
Copy link
Contributor

This should've been resolved by #2937. When was docs hub last updated?

@petertonysmith94
Copy link
Contributor Author

I can see that it's not in the apps/docs/.typedoc/api-links.json. Potentially the docs-hub uses the directory contents for constructing these navigation items (so it's a docs-hub issue).

I'd favour isolating the API docs and referencing it, like what was discussed in sync.

@maschad
Copy link
Member

maschad commented Aug 28, 2024

I'd favour isolating the API docs and referencing it, like what was discussed in sync.

I agree as well, I think that would be the ideal solution rather than maintaining these API docs via a hacky postbuild script it seems like misappropriated engineering resources in my opinion.

@petertonysmith94
Copy link
Contributor Author

Added the following.

Would we want to close this or move the issue to the docs-hub?

@danielbate
Copy link
Contributor

My preference would be to close this and just do #3058. I imagine the docs hub nav setup is probably as fragile as the typedoc postbuild script. Probably worth just doing the above.

@petertonysmith94
Copy link
Contributor Author

@petertonysmith94 petertonysmith94 closed this as not planned Won't fix, can't repro, duplicate, stale Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue is a bug
Projects
None yet
Development

No branches or pull requests

3 participants