docs: fix typos and inaccuracies in README, guides, and designreview prompts - #587
docs: fix typos and inaccuracies in README, guides, and designreview prompts#587Emillock wants to merge 4 commits into
Conversation
|
Hi @Emillock thank you for your contribution! We triage based on GitHub issues and like to keep changes to rules even grammar managed closely. Would you consider sending a "documentation only" version separately outside of the rules and log others as bugs or suggestions? Thanks! |
…ections Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…t files The JSON output examples were closed with ```text, which is not a valid closing fence (info strings are only allowed on opening fences), so the Rules sections rendered inside the code block on GitHub. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The guide said six workflows, but eight exist. Add ci.yml (markdown lint) and codeql.yml (CodeQL analysis) to the repo tree, CI/CD architecture intro, and both permissions tables. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Hello @scottschreckengaust. Thanks for the guidance! I have reworked this PR in place to be the documentation-only version: it now touches only README.md, CONTRIBUTING.md, docs/, and the designreview prompt files, with nothing under aidlc-rules/. The title and description are updated to match. The rules-related findings are logged as issues instead:
Each issue links to a reference branch on my fork in case that is useful during triage. One scoping question: I kept the scripts/aidlc-designreview prompt-fence fix here since it is outside aidlc-rules/, but it is tool configuration rather than pure documentation. Happy to drop it from this PR and file it as an issue too if you would prefer. |
Summary
Documentation-only fixes, per maintainer feedback: this PR now touches nothing under aidlc-rules/. It fixes typos and grammar in the README and contributor docs, corrects an outdated workflow count in the administrative guide, and repairs invalid markdown fences in the designreview prompt files. The rules-related findings from the original version of this PR are logged separately as #588, #589, #590, and #591.
Changes
GH_TOKENsetup lineci.ymlandcodeql.ymladded to the repo tree and permissions tables)```text, which is not a valid closing fence, so the Rules sections rendered inside the code block on GitHubUser experience
Before: several docs contained garbled sentences, the administrative guide undercounted the CI workflows, and the designreview prompt files rendered their Rules sections inside a code block.
After: docs read and render correctly. No files under aidlc-rules/ are touched.
Checklist
Test Plan
npx markdownlint-cli2 "**/*.md": 133 files, 0 errorsgit diff main --stat: only README.md, CONTRIBUTING.md, docs/, and scripts/aidlc-designreview/config/prompts/ change; nothing under aidlc-rules/Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.