docs: add Table of Contents for improved navigation#2
Open
shillat wants to merge 6 commits intobos-com:mainfrom
Open
docs: add Table of Contents for improved navigation#2shillat wants to merge 6 commits intobos-com:mainfrom
shillat wants to merge 6 commits intobos-com:mainfrom
Conversation
Added a table of contents and sections for available scripts and learning resources.
Updated the README to improve formatting and clarity.
Updated the Table of Contents in the README file to include additional scripts and sections.
|
@shillat is attempting to deploy a commit to the mukisalivingstone133-9917's projects Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR introduces a Table of Contents (TOC) to the main README.md. As the project documentation grows, providing internal navigation links reduces "scroll fatigue" and allows developers to jump directly to specific scripts or troubleshooting steps.
Changes
Added a linked Table of Contents at the top of the document.
Categorized the "Learn More" sections into logical sub-groups (Optimization, Configuration, and Troubleshooting).
Ensured all anchors align with GitHub Flavored Markdown (GFM) for seamless navigation.
Reasoning
A "10/10" README prioritizing Developer Experience (DX) should be scannable. By implementing this TOC, we align this project with open-source documentation best practices, making it more accessible for first-time contributors and users.