Skip to content

Add Quick Navigation section to README#749

Open
harsh2b wants to merge 3 commits intouptrain-ai:mainfrom
harsh2b:harsh2b/readme-navigation
Open

Add Quick Navigation section to README#749
harsh2b wants to merge 3 commits intouptrain-ai:mainfrom
harsh2b:harsh2b/readme-navigation

Conversation

@harsh2b
Copy link
Copy Markdown

@harsh2b harsh2b commented Oct 7, 2025

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Description

This PR adds a 'Quick Navigation' section to the README.md file.
This section uses visually appealing badges to link directly to major sections of the README, improving readability and navigation for users.

Checklist

  • I have read the CONTRIBUTING document.
  • My code follows the code style (BLACK) of this project.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have updated the documentation accordingly.
  • I have added an appropriate CHANGELOG entry.

Author's Note

I hope this makes more easy for other users to find things.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant