Add documentation review guidelines to .github/instructions and align README writing style section#1075
Conversation
…gn README writing style section
There was a problem hiding this comment.
Pull request overview
This PR adds a dedicated documentation review guideline file under .github/instructions (scoped to astro/src/content/**/*.{md,mdx}) and updates the README’s “Writing Style” section to better reflect the intended documentation voice and standards.
Changes:
- Expanded README “Writing Style” bullets to more explicitly define tone, concision, and educational intent.
- Added
.github/instructions/docs.instructions.mdwith review guidelines covering style, frontmatter, links, Markdown, code blocks, and redirects.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Updates authoring “Writing Style” guidance to be more specific about tone and clarity. |
| .github/instructions/docs.instructions.md | Introduces structured documentation review standards for docs content under astro/src/content. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
wcabus
left a comment
wcabus
left a comment
There was a problem hiding this comment.
Copilot already gave the remarks, nothing additional from me
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No description provided.