Generate documentation #602
Merged
+751
−415
Conversation
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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
This PR aims to automate the generation and updating of documentation for GitHub MCP tools and toolsets. Key changes include:
- Adding a Go script (generate_docs.go) to generate README sections automatically.
- Updating the README.md file with clearly demarcated automated sections.
- Introducing a GitHub workflow to enforce documentation consistency.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| cmd/github-mcp-server/generate_docs.go | New documentation generator script using mocked clients and automated section replacement. |
| README.md | Updated API and tool documentation with automated sections markers. |
| .github/workflows/docs-check.yml | New GitHub Actions workflow to check for documentation consistency on PRs. |
SamMorrowDrums
force-pushed
the
auto-documentation
branch
7 times, most recently
from
dcdc124 to
514db47
Compare
JoannaaKL
previously approved these changes
Jun 27, 2025
SamMorrowDrums
force-pushed
the
auto-documentation
branch
from
514db47 to
e2a3d7b
Compare
SamMorrowDrums
force-pushed
the
auto-documentation
branch
from
e2a3d7b to
0c68090
Compare
JoannaaKL
approved these changes
Jun 27, 2025
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.
Adds a script, workflow and updates the documentation to be both generated and deterministic so that we don't forget to update it.