Conversation
…ed GitHub browsing Co-authored-by: pardeike <853584+pardeike@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] I think we can improve the documentation. If I am not mistaken, GitHub will show markdown files when browsing subdirectories (with a browser). If so (and only if), you should add documentation that shows when surfing to the important directories like E...
Add README.md files to directories for improved GitHub browsing experience
Sep 13, 2025
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
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.
This PR improves the documentation and user experience when browsing the GABP repository on GitHub by adding comprehensive README.md files to all major directories.
Problem
When users browse subdirectories like
EXAMPLES/1.0/orSCHEMA/1.0/methods/on GitHub, they see only file listings without context about what the directory contains or how to use the files. This makes it difficult for developers to understand the repository structure and find relevant documentation.Solution
Added 13 new README.md files that GitHub will automatically display when browsing directories:
Key Features
Each README.md provides:
For example, browsing to
EXAMPLES/1.0/handshake/now shows a detailed explanation of the GABP handshake process, what each example file demonstrates, and which schemas to validate against.Benefits
The changes are purely additive and don't modify any existing functionality or break any existing workflows.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.