Add docs style instructions for copilot agents#1236
Open
Conversation
Add .github/instructions/docs-style.instructions.md scoped to docs/** with style rules aligned to docs.github.com conventions. Covers headings, callouts, lists, em dashes, code snippets, and more. Add reference in .github/copilot-instructions.md so agents know the docs instructions exist. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds repository-scoped Copilot agent instructions to align content under docs/** with docs.github.com style conventions, supporting the docs normalization/sync pipeline.
Changes:
- Adds
.github/instructions/docs-style.instructions.mdwithapplyTo: "docs/**"to enforce docs style conventions (headings, callouts, lists, em dashes, index.md rules, etc.). - Adds a reference to the new docs style instructions in
.github/copilot-instructions.md.
Show a summary per file
| File | Description |
|---|---|
| .github/instructions/docs-style.instructions.md | New Copilot instructions file that codifies docs.github.com-compatible style rules for docs/**. |
| .github/copilot-instructions.md | Adds a pointer so agents/contributors can discover the docs style instructions. |
Copilot's findings
- Files reviewed: 2/2 changed files
- Comments generated: 2
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Add docs style instructions for Copilot agents
Closes: https://github.com/github/docs-content/issues/22194
Adds custom agent instructions so that Copilot (and contributors) follow docs.github.com style conventions when writing or editing content in
docs/. This is part of the docs normalization pipeline work (docs-content#22187) — the closer SDK docs match Docs style up front, the less transformation the pipeline has to do and the fewer things to fix during review.What is it
A new file at
.github/instructions/docs-style.instructions.mdwithapplyTo: "docs/**"so it automatically activates when agents work on docs files. It covers:> [!NOTE]not> **Note:**)docs-validate)Also adds a one-line reference in
.github/copilot-instructions.mdso agents know the docs instructions exist.What it does NOT change
justfiletasksdocs/**)How it works for contributors
Nothing changes about how you write docs. If you're using Copilot to help write or edit docs, the instructions are picked up automatically. If you're writing manually, the file is a quick reference for common patterns.
Related