Skip to content

Add daily documentation sync from gh-aw repository#260

Closed
Copilot wants to merge 3 commits into
mainfrom
copilot/import-adapt-daily-docs
Closed

Add daily documentation sync from gh-aw repository#260
Copilot wants to merge 3 commits into
mainfrom
copilot/import-adapt-daily-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 14, 2026

The MCP Gateway specification lives in the githubnext/gh-aw repository (as Astro documentation), but this repository needs a local markdown copy for offline reference and reduced external dependencies.

Changes

  • Sync script (scripts/sync-docs.sh): Fetches mcp-gateway.md from gh-aw, strips Astro frontmatter, adds source attribution
  • Daily workflow (.github/workflows/sync-docs.yml): Scheduled sync at 2:00 AM UTC, creates PR when changes detected
  • Documentation (docs/mcp-gateway.md): Full specification synced from gh-aw (1,416 lines)
  • Updated references: README.md and AGENTS.md now link to local docs instead of gh-aw URLs

Implementation details

The sync script is idempotent and adds this notice to synced docs:

> **Note**: This documentation is automatically synced from the [githubnext/gh-aw repository](https://github.com/githubnext/gh-aw/blob/main/docs/src/content/docs/reference/mcp-gateway.md) daily. 
> The official specification is maintained in the gh-aw project and is the authoritative source for compliance testing.

Manual sync: ./scripts/sync-docs.sh

Existing documentation (DIFC_INTEGRATION_PROPOSAL.md, HTTP_BACKEND_SESSION_ID.md) remains unchanged.

Original prompt

Import and adapt daily documentation updated from githubnext/gh-aw

  • there is no astro here, just markdown files in /docs

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@pelikhan
Copy link
Copy Markdown
Collaborator

@copilot import technical doc writer as well (optimized for flat markdown docs)

Copilot AI and others added 2 commits January 14, 2026 14:48
- Created sync script to fetch and adapt MCP Gateway docs
- Added GitHub Actions workflow for daily automated sync
- Updated README and AGENTS.md to reference local docs
- Added docs/README.md explaining sync process
- Synced initial documentation from gh-aw

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Import and adapt daily documentation from githubnext/gh-aw Add daily documentation sync from gh-aw repository Jan 14, 2026
Copilot AI requested a review from pelikhan January 14, 2026 14:53
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jan 14, 2026

@copilot import technical doc writer as well (optimized for flat markdown docs)

Are you asking me to also sync the markdown.md guide from gh-aw (the guide for writing effective workflow markdown instructions)? Or is there a different technical doc writer guide you'd like me to import?

I found docs/src/content/docs/reference/markdown.md in gh-aw which contains guidelines for writing effective agentic workflow documentation. Should I add this to the sync script?

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/githubnext/gh-aw/contents/docs/src/content/docs
    • Triggering command: /usr/bin/curl curl -fsSL REDACTED (http block)

If you need me to access, download, or install something from one of these locations, you can either:

@pelikhan pelikhan closed this Jan 15, 2026
@lpcox lpcox deleted the copilot/import-adapt-daily-docs branch January 24, 2026 20:51
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.

2 participants