docs(style): adds plain english guidelines and document formatting skill - #16
Merged
Merged
Conversation
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
A critical .gitmodules issue and several documentation consistency issues remain unresolved.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 1
Open (4)
What changed in this PR
Adds plain-English guidance and a reusable AsciiDoc documentation-formatting skill.
Changes:
- Registers the external writing-skills submodule.
- Adds documentation conventions, templates, and examples.
- Updates
AGENTS.mdwith writing guidance.
| File | Review summary |
|---|---|
AGENTS.md |
nit (4 votes): Replace AsciiDoc link: syntax with Markdown links. |
.gitmodules |
critical (4 votes): Add branch = main; otherwise submodule maintenance fails. |
.ai/skills/documents/SKILL.md |
No final comments. |
.ai/skills/documents/assets/example-decision-burrito-decision.adoc |
nit (4 votes): Fix the invalid document reference. nit (1 vote): Add :toc: for consistent navigation. |
.ai/skills/documents/assets/example-ash-domain-erd.adoc |
nit (4 votes): Change “eight resources” to “nine.” |
.ai/skills/documents/assets/document-template.adoc |
nit (1 vote): Resolve the default :toc: conflict for short notes. |
.ai/skills/documents/assets/decisions/related-decision.adoc |
No final comments. |
.ai/skills/documents/assets/decisions/decision.adoc |
No final comments. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+45
to
+47
| [submodule "vendor/claude-plain-english-skill"] | ||
| path = vendor/claude-plain-english-skill | ||
| url = git@github.com:b1rdmania/claude-plain-english-skill |
|
|
||
| == ERD diagram | ||
|
|
||
| All eight resources and their GraphQL/nested-data associations. |
| == History | ||
|
|
||
| The initial packaging decision and empirical `exqlite` cross-build validation | ||
| are recorded in link:phase-8-plan.adoc[Phase 8]. Later Burrito-specific |
Comment on lines
+38
to
+42
| Use the link:vendor/claude-plain-english-skill/skills/simple-english[`simple-english`] skill when | ||
| authoring technical documentation or instructions. | ||
|
|
||
| Use the link:vendor/claude-plain-english-skill/skills/plain-english[`plain-english`] skill when | ||
| authoring non-technical documentation, marketing copy, or other content intended for a general audience. |
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.
No description provided.