Add agent instructions for aligning with Google style guide#91
Open
nscuro wants to merge 2 commits into
Open
Conversation
We already lint against the style guide's Value rules, makes sense to directly reference the guide in agent instructions. Signed-off-by: nscuro <nscuro@protonmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds explicit documentation language/style guidance to AGENTS.md by referencing the Google developer documentation style guide, aligning the agent instructions with the existing Vale rules and Diataxis conventions.
Changes:
- Add a new “Language and style” section pointing writers to the Google style guide plus repo-specific writing guidance.
- Clarify how Diataxis guidance overrides Google style in specific cases (notably tutorials voice).
- Add an explicit Markdown convention about ending files with a trailing newline (referencing markdownlint MD047).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Niklas <nscuro@protonmail.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.
We already lint against the style guide's Value rules, makes sense to directly reference the guide in agent instructions.