Generate documentation#602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged

Jun 27, 2025

Merged

Jun 27, 2025

+751 −415

Conversation

Copy link

Collaborator

Adds a script, workflow and updates the documentation to be both generated and deterministic so that we don't forget to update it.

CopilotAI review requested due to automatic review settings

SamMorrowDrums requested a review froma team as acode owner

github-advanced-securitybot found potential problems

.github/workflows/docs-check.yml FixedShow fixedHide fixed

CopilotAI reviewed

Copy link

Contributor

The reason will be displayed to describe this comment to others.Learn more.

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.

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.