docs: fix typos and inaccuracies in README, guides, and designreview prompts - #587
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! |
|
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. |
10e8845 to
b96abed
Compare
|
Rebuilt this PR on current |
leandrodamascena
left a comment
There was a problem hiding this comment.
Thanks for working on this @Emillock! Approved.
apackeer
left a comment
There was a problem hiding this comment.
Reviewed the documentation-only changes against the current workflow definitions. No blocking issues found.
Summary
Documentation-only refresh rebuilt on the current
mainbranch. The PR now contains only still-relevant wording and administrative-guide fixes; it does not touchaidlc-rules/and does not reintroduce the removedscripts/aidlc-designreview/tree.Changes
GH_TOKENsetup and aligned security-scanner behavior with the current workflow.ci.yml,codeql.yml, anddocs.yml; aligns triggers, environments, permissions, scanner thresholds, and result publication with the current workflow YAML.Scope
Only these four files change:
README.mdCONTRIBUTING.mddocs/ADMINISTRATIVE_GUIDE.mddocs/DEVELOPERS_GUIDE.mdValidation
npx --yes markdownlint-cli2 README.md CONTRIBUTING.md docs/ADMINISTRATIVE_GUIDE.md docs/DEVELOPERS_GUIDE.md: 0 issues..github/workflows/.git diff --check: clean.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.