GH-513: Implement Table of Contents and Fix Formatting#514
GH-513: Implement Table of Contents and Fix Formatting#514LordZibblington wants to merge 3 commits into
Conversation
Undo previous removal of the hashtag from the markdown header links. GitHub web incorrectly shows the links break when the website is functional.
|
Hello, thank you for the feedback! I agree that a list of each builder already exists, and it's useful if someone just wants to quickly navigate to something they're already aware of. I implemented the Table of Contents based on my own personal new-user experience using the NPC Meta. I found it overwhelming and had no idea where to look, to the point that I copied the entire document over to Google Docs and ran a script to add the headers myself. My only goal here is to bring the NPC Meta to a point that I can comfortably work within it and replace the google doc, rather than resort to it to get a better picture of what's going on, and my standard is feeling I can fully replace the document I currently use because the NPC Meta accurately represents the present information. An example of the difficulty using the NPC Meta is if a person wants to look for core components that handle interaction with entities. In the Table of Contents and the Meta itself, this is clearly listed as "Core Components (Entity)" and all relevant builders are grouped together. There is no indication of this in the current Builder list, which wastes the presence of the headings already categorizing the builders. I'm more than open to alternatives, having already investigated whether making the List of Builders sortable by each column and adding headers was viable. It's not possible within MDX without requiring a user to have a browser add-on, at least as far as my research showed, so I'm implementing the Table of Contents as my own interpretation of how to solve the issue. Thank you for your time! |

Pull Request
Description
Implement a table of contents and fix the formatting for the developers' header links.
Type of Change
Screenshots
If applicable, add before/after screenshots:
Checklist
bun run devbun formatbun audit(no critical vulnerabilities)Thank you for contributing!