Repository navigation
Prefer plain language in documentation - #77
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 40bf5936-fdf2-408a-afe7-dd07b66ed7da
Fernando de Oliveira (fedeoliv)
added
the
documentation
This was referenced Oct 16, 2026
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
1 participant
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.
Discussion Link
Link: No linked discussion. Work is tracked by #40.
Context
Uncommon or academic vocabulary makes framework-generated documentation harder for non-native English speakers to follow.
Closes #40
Solution
Add concrete plain-word examples to the shared documentation-style skill and publish the same guidance through repository instructions, distributed templates, and the quality guide. Preserve precise domain terms, API names, code identifiers, and quotations.
Validation
npm --prefix docs run build: passed in an isolated snapshot of this PR's committed tree (39 pages).node --check docs/astro.config.mjs: passed.git diff origin/main feature/40-plain-language --check: passed.markdownlint --stdin --json --config .markdownlint.yaml: no new diagnostics versus the base across 6 changed Markdown/MDX files. Existing diagnostics are unchanged.bash .github/plugins/devsquad/hooks/sdd-init.sh verify: integrated-stack output matches the pre-change baseline, including existing customized files and missing managed-template targets.Checklist