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

[Bug] api/index.md link in toc.yml breaks API docs #10334

Open
mikernet opened this issue Oct 30, 2024 · 1 comment
Open

[Bug] api/index.md link in toc.yml breaks API docs #10334

mikernet opened this issue Oct 30, 2024 · 1 comment
Labels
bug A bug to fix

Comments

@mikernet
Copy link
Contributor

mikernet commented Oct 30, 2024

Describe the bug
I prefer my table of contents "API documentation" link to point the page where it shows all the main namespaces instead of going to the first type, i.e. I prefer it to go here:

Image

The problem is that setting up the toc.yml file like this:

- name: API Documentation
  href: api/

Goes directly to the first type in the first namespace instead of the view with all the namespaces....so, this should work instead:

- name: API Documentation
  href: api/index.md

But alas, it does not - when you click the link, it shows blank content and all of the API docs are gone. None of the API docs work, even if you link directly to a member. It breaks the entire site for some reason. Note that api/index.md links within markdown documents work just fine.

This works, but it causes warning InvalidFileLink: Invalid file link:(~/api/index.html) during docfx build:

- name: API Documentation
  href: api/index.html
@mikernet mikernet added the bug A bug to fix label Oct 30, 2024
@filzrev
Copy link
Contributor

filzrev commented Oct 31, 2024

What happens if a topicHref is specified as followings?

- name: API Documentation
  href: api/
  topicHref: api/index.md

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

No branches or pull requests

2 participants