Skip to content

docs(labs): markdownlint cleanup across labs/ READMEs (fixes #54)#55

Merged
ManojRamani merged 1 commit intoaws-samples:mainfrom
ManojRamani:fix/issue-54-readme-lint
May 7, 2026
Merged

docs(labs): markdownlint cleanup across labs/ READMEs (fixes #54)#55
ManojRamani merged 1 commit intoaws-samples:mainfrom
ManojRamani:fix/issue-54-readme-lint

Conversation

@ManojRamani
Copy link
Copy Markdown
Contributor

Summary

Fixes #54. Content-preserving cleanup of pre-existing markdownlint warnings across every `README.md` under `labs/` and `labs/AGENTS.md`. Zero content changes — only whitespace, code-fence language tags, URL bracketing, bullet style, trailing whitespace, and table pipe padding.

Rules addressed:

Rule Description Where
MD022 blanks-around-headings All module READMEs + AGENTS.md
MD032 blanks-around-lists All module READMEs + AGENTS.md
MD040 fenced-code-language AGENTS.md + module1/README (directory-tree fences now tagged `text`)
MD034 bare-url module4/README (Tavily / Nova Act links)
MD004 ul-style module4/README (`*` → `-`)
MD009 trailing-spaces module1/README, module5/README
MD060 table-column-style AGENTS.md module-overview table
orphan empty fence module1/README (removed)
missing terminal newline weather_server/README

Test plan

  • Render each modified file on GitHub (or locally) and confirm the rendered output is visually identical to `main`.
  • Run `markdownlint labs//*.md labs//AGENTS.md` (or the IDE's markdownlint) and confirm zero warnings on the files in this diff.

Scope

Explicitly style-only. No structural, link-target, or section-title changes. Filing separately from #50 / #51 / #52 so the diff is easy to verify as content-preserving.

Pre-existing style drift, no content changes:

- MD022/MD032 — blank line after every `###`/`##` heading before the list
  that follows, and blank line before each list (AGENTS.md, module1/README,
  module2/README, module3/README, module5/README, weather_server/README).
- MD040 — language tag on previously-unlabeled code fences (`text` for the
  ASCII directory trees in AGENTS.md and module1/README).
- MD034 — bare URLs in module4/README wrapped in angle brackets
  (`<https://tavily.com>`, `<https://nova.amazon.com/dev-apis>`).
- MD004 — module4/README converted `*` bullets to `-` to match the rest of
  the repo.
- MD009 — removed trailing spaces (module1/README's "Understanding memory"
  line, module5/README's final paragraph).
- MD060 — AGENTS.md module-overview table pipes padded with spaces.
- Removed orphaned empty trailing code fence at the bottom of
  module1/README.
- Trivial missing terminal newline on weather_server/README.

Fixes aws-samples#54.
@ManojRamani ManojRamani requested a review from tannermcrae May 7, 2026 05:26
@ManojRamani ManojRamani merged commit bfa9ffb into aws-samples:main May 7, 2026
@ManojRamani ManojRamani deleted the fix/issue-54-readme-lint branch May 7, 2026 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Markdownlint cleanup across labs/ READMEs

1 participant