Conversation
Signed-off-by: 1fanwang <1fannnw@gmail.com>
Contributor
There was a problem hiding this comment.
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/instructionswithdocs/**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
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.
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
The existing documentation extractor produces the same examples, and the TypeScript snippet validator passes.