Skip to content

Keep authoring guidance out of published SDK docs #2764

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
1fanwang wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Keep authoring guidance out of published SDK docs #2764

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/AGENTS.md → ...b/instructions/docs-style.instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
applyTo: "docs/**"
---

# Copilot SDK docs style guide

This style guide applies to all documentation in the `docs/` directory. These docs are synced to `github/docs-internal` via a normalization pipeline, so they must follow the conventions below to be compatible with docs.github.com.
Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
- Test harness & E2E: `<SDK_ROOT>/test/harness/*`, Python harness wrapper `<SDK_ROOT>/python/e2e/testharness/proxy.py`
- Schemas and type generation: `<SDK_ROOT>/scripts/codegen/` and `<SDK_ROOT>/java/scripts/codegen/`
- Session snapshots used by E2E: `<SDK_ROOT>/test/snapshots/` (used by the replay proxy)
- Docs style guide: `<SDK_ROOT>/docs/AGENTS.md`
- Docs style guide: `<SDK_ROOT>/.github/instructions/docs-style.instructions.md`

## Developer workflows (commands you’ll use often) ▶️

Expand Down