Skip to content

docs: fix typos and inaccuracies in README, guides, and designreview prompts - #587

Merged
leandrodamascena merged 1 commit into
awslabs:mainfrom
Emillock:fix/doc-typos
Aug 19, 2026
Merged

docs: fix typos and inaccuracies in README, guides, and designreview prompts#587
leandrodamascena merged 1 commit into
awslabs:mainfrom
Emillock:fix/doc-typos

Conversation

@Emillock

@Emillock Emillock commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Summary

Documentation-only refresh rebuilt on the current main branch. The PR now contains only still-relevant wording and administrative-guide fixes; it does not touch aidlc-rules/ and does not reintroduce the removed scripts/aidlc-designreview/ tree.

Changes

  • README: corrected the Method Definition Paper reference, Codex verification prompt, resiliency wording, and Claude Code capitalization.
  • CONTRIBUTING: corrected PowerShell capitalization.
  • Developers Guide: clarified GH_TOKEN setup and aligned security-scanner behavior with the current workflow.
  • Administrative Guide: documents all nine current workflows, including ci.yml, codeql.yml, and docs.yml; aligns triggers, environments, permissions, scanner thresholds, and result publication with the current workflow YAML.

Scope

Only these four files change:

  • README.md
  • CONTRIBUTING.md
  • docs/ADMINISTRATIVE_GUIDE.md
  • docs/DEVELOPERS_GUIDE.md

Validation

  • npx --yes markdownlint-cli2 README.md CONTRIBUTING.md docs/ADMINISTRATIVE_GUIDE.md docs/DEVELOPERS_GUIDE.md: 0 issues.
  • Confirmed exactly nine workflow files under .github/workflows/.
  • git diff --check: clean.
  • Independent factual review against every current workflow YAML: no findings.

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.

@Emillock
Emillock requested review from a team as code owners July 15, 2026 20:16
@github-actions github-actions Bot added documentation Improvements or additions to documentation rules labels Jul 15, 2026
@scottschreckengaust scottschreckengaust added the do-not-merge Halts a pull request from merging label Jul 15, 2026
@Emillock Emillock changed the title Fix/doc typos docs: fix typos, stale stage names, and rendering issues across rules and docs Jul 15, 2026
@scottschreckengaust

Copy link
Copy Markdown
Member

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!

@github-actions github-actions Bot removed the rules label Jul 15, 2026
@Emillock Emillock changed the title docs: fix typos, stale stage names, and rendering issues across rules and docs docs: fix typos and inaccuracies in README, guides, and designreview prompts Jul 15, 2026
@Emillock

Copy link
Copy Markdown
Contributor Author

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.

@leandrodamascena leandrodamascena removed the do-not-merge Halts a pull request from merging label Aug 19, 2026
@leandrodamascena

Copy link
Copy Markdown
Contributor

Rebuilt this PR on current main and removed all obsolete changes. The branch now contains one documentation-only commit (b96abed0), touches exactly four files, documents all nine current workflows, and does not reintroduce scripts/aidlc-designreview/. Markdown lint, workflow inventory, diff checks, and an independent workflow-YAML review are clean.

@leandrodamascena leandrodamascena left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this @Emillock! Approved.

@apackeer apackeer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the documentation-only changes against the current workflow definitions. No blocking issues found.

@leandrodamascena
leandrodamascena added this pull request to the merge queue Aug 19, 2026
Merged via the queue into awslabs:main with commit 45f5c9b Aug 19, 2026
27 of 33 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants