Conversation
There was a problem hiding this comment.
Pull request overview
Adds a visible title to the API index page so the new web documentation generator can populate navigation labels.
Changes:
- Add a Markdown heading (“Index”) at the top of
doc/api/index.md. - Remove an outdated top-of-file comment block.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| NB(chrisdickinson): if you move this file, be sure to update | ||
| tools/doc/html.mjs to point at the new location. | ||
| --> | ||
| # Index |
There was a problem hiding this comment.
| # Index | |
| # Node.js documentation |
There was a problem hiding this comment.
It would be great to include the version in which it exists in that title, but I’m not sure if that’s possible.
There was a problem hiding this comment.
It would be great to include the version in which it exists in that title, but I’m not sure if that’s possible.
That's already included as a header above this
There was a problem hiding this comment.
There was a problem hiding this comment.
I see. I apologize, I was referring to the legacy-html documentation when I said the header already existed (which is contradictory to my PR, lol). I do agree that having some kind of version indicator would be nice, however, it would require some sort-of replacing logic on the web generator, which wouldn't be backported to the legacy generator. As such, we should put a 'pin' in that idea, and implement it with #62045.
A title on this page is needed for the new
webgenerator to populate the navigation.