Skip to content

Keep authoring guidance out of published SDK docs - #2764

Open
1fanwang wants to merge 1 commit into
github:mainfrom
1fanwang:1fannnw/keep-docs-guide-unpublished
Open

1fanwang wants to merge 1 commit into
github:mainfrom
1fanwang:1fannnw/keep-docs-guide-unpublished

Conversation

@1fanwang

Copy link
Copy Markdown
Contributor

The docs sync currently includes the contributor style guide, so it would publish authoring instructions as an SDK documentation page. Keep that guidance outside the synced tree while retaining its docs/** scope and the root guide's pointer.

Fixes #2758

Testing

Reproduced the reporter's directory-copy boundary locally. The authoring guide was copied before this change and is excluded afterward; every remaining source file is unchanged. The hosted docs sync was not run.

Local source-copy check
$ mkdir -p .scratch/docs-sync
$ rsync -a --delete --exclude=.validation/ --exclude=developer-docs/ docs/ .scratch/docs-sync/
$ test ! -f .scratch/docs-sync/AGENTS.md
# Before: exit 1
# After: exit 0

The existing documentation extractor produces the same examples, and the TypeScript snippet validator passes.

Signed-off-by: 1fanwang <1fannnw@gmail.com>
@1fanwang
1fanwang requested a review from a team as a code owner September 24, 2026 05:56
Copilot AI balanced review requested due to automatic review settings September 24, 2026 05:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

The relocation prevents publication while retaining discoverability and scope.

Review effort: Balanced
Findings: None

What changed in this PR

Relocates contributor-only documentation guidance outside the published docs/ tree while preserving its scope.

Changes:

  • Moves the style guide under .github/instructions with docs/** targeting.
  • Updates the root guidance link.
File Description
AGENTS.md Points to the relocated style guide.
.github/​instructions/​docs-style.instructions.md Adds front matter preserving docs/** scope.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

This branch has not been deployed

No deployments
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.

docs/AGENTS.md is repo authoring guidance, but everything in docs/ gets published

2 participants