Remove PR #88 review scratch docs#122
Merged
Merged
Conversation
The spec/comprehensive-documentation/ directory was committed by accident in PR #88. Its files are PR-authoring artifacts (comment checklists, triage notes, doc-review findings) rather than project documentation, and one even references a personal local path. They track a now-closed review process and don't belong in the repo. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 task
sir-sigurd
added a commit
that referenced
this pull request
Jun 9, 2026
With spec/ removed (#122), there's no working-notes directory left to avoid, so widen the glob from top-level *.{md,markdown} to recursive **/*.{md,markdown} in both the config and the CI action (the action's default glob is non-recursive and overrides the config, so it's set explicitly). This auto-covers future nested docs like module READMEs. The only newly-linted file, .github/pull_request_template.md, opens with a section heading rather than an H1; skip first-line-heading inline since it's a template fragment, not a standalone document. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
sir-sigurd
added a commit
that referenced
this pull request
Jun 10, 2026
* Add markdownlint CI job and fix broken doc links
Add a markdownlint job to CI that lints the top-level Markdown docs with
markdownlint-cli2, configured via .markdownlint-cli2.yaml. The config
disables noisy/stylistic rules (line-length, bold-as-heading,
table-pipe-spacing), sets MD024 to siblings-only for the CHANGELOG, and
globs *.{md,markdown} (non-recursive) so spec/ working notes and .github/
are excluded.
Fix the existing violations to establish a green baseline:
- README: repair the stale table of contents (drop entries with no
in-doc target, add the real sections), demote stray H1s to H2 with
subsections bumped one level, add languages to bare code fences.
- OPERATIONS: fix cross-reference anchors that omitted the heading's
"(N minutes)" suffix.
- Normalize blank lines around headings, fences, and lists.
Two OPERATIONS checklist links (#capacity-monitoring, #security-audit)
point to sections that do not exist yet; they are left in place with an
inline markdownlint-disable and a TODO referencing the issue.
Fixes #95
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Fill in CHANGELOG PR number
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Use rule-name aliases in markdownlint config
Reference rules by their readable names (line-length, no-emphasis-as-heading,
table-column-style, no-duplicate-heading) instead of MD0xx IDs.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Drop CHANGELOG entry
A CI/docs-tooling change does not warrant a release note.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Use rule-name alias in inline disable directives
Reference link-fragments instead of MD051 in the markdownlint-disable
comments, matching the config style.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Add blank line before list in CHANGELOG
Pre-existing MD032 violation surfaced by the new markdownlint baseline.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Correct MD060 description in config comment
table-column-style (MD060) governs table cell padding consistency; the
previous comment described it as "table pipe spacing," which is MD055.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Defer README TOC fix to a separate PR
Restore the original table-of-contents entries verbatim and suppress the
broken in-doc anchors with a markdownlint-disable block plus a TODO
referencing #95, rather than deciding the TOC restructure here. The
navigation/content decision (which sections belong, cross-doc links)
belongs in a focused PR; this one stays scoped to the lint baseline.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Lint all Markdown recursively
With spec/ removed (#122), there's no working-notes directory left to
avoid, so widen the glob from top-level *.{md,markdown} to recursive
**/*.{md,markdown} in both the config and the CI action (the action's
default glob is non-recursive and overrides the config, so it's set
explicitly). This auto-covers future nested docs like module READMEs.
The only newly-linted file, .github/pull_request_template.md, opens with
a section heading rather than an H1; skip first-line-heading inline since
it's a template fragment, not a standalone document.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Use disable-file for the template's first-line-heading exemption
MD041 is about the file's first line, so the exemption belongs to the
whole file, not one line. disable-line was positional and would silently
stop working if the template gained a line above the heading.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Lint Markdown via pinned npx instead of the action
Replace DavidAnson/markdownlint-cli2-action@v23 with a pinned
`npx markdownlint-cli2@0.22.1` run.
A moving major action tag auto-adopts new releases that can add or
tighten rules and break CI with no repo change; a pinned npm version is
content-immutable, so the linter is reproducible. It also matches the
local invocation, and lets the config's globs drive file selection
without duplicating them in the workflow.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Tighten TOC link suppressions and fix two retargetable entries
- Retarget Troubleshooting and Terraform Commands Reference to the real
sections; only the five entries needing cross-doc decisions (#95) stay.
- Switch the README disable block to per-line disables so a TOC entry
added later still gets dead-anchor checking.
- Reword the TODO: #95 tracks the broken links themselves, not a
restructure.
- Indent the suppression comments under the preceding list item so the
TOC and checklists render as single lists (an unindented HTML comment
between bullets splits the list).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Freeze the linter via lockfile and ignore vendored trees
- Move the markdownlint-cli2 pin into package.json + package-lock.json
and run `npm ci` in CI: a bare `npx <pkg>@<version>` still resolves
deep transitive deps fresh on every run, while the lockfile freezes
the whole tree and makes the pin visible to update tooling.
- Add `ignores` for .terraform/ and node_modules/: markdownlint-cli2
has no default exclusions, and `terraform init` vendors registry
modules whose READMEs would fail local runs.
- Ignore node_modules in .gitignore.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Trim package.json to the essentials
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Description
spec/comprehensive-documentation/was committed by accident in #88. Its five files are PR-authoring artifacts, not project documentation:pr-88-comments-checklist.md,pr-88-triage.md— tracking resolution of that PR's review commentsexamples-review.md,operations-guide-review.md— review checklists for docs in that PRexamples-review-findings.md— analysis notes, including a hardcoded personal local path (/Users/ernest/GitHub/...)They document a now-closed review process and have nothing to do with the IaC modules. This PR removes the directory.
TODO
🤖 Generated with Claude Code
Greptile Summary
Removes the
spec/comprehensive-documentation/directory, which was accidentally committed as part of PR #88 and contains only internal PR-authoring scratch files unrelated to the IaC modules./Users/ernest/GitHub/...).Confidence Score: 5/5
Safe to merge — all changes are pure file deletions of internal scratch documents with no impact on IaC modules or configuration.
Every changed file is a markdown scratch document accidentally committed during PR #88. Deleting them has no effect on any module, configuration, or runtime behaviour in the repository.
No files require special attention.
Important Files Changed
/Users/ernest/GitHub/...); no project relevance.Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[PR #88 - Accidentally committed\nspec/comprehensive-documentation/] --> B[5 scratch markdown files\nlanded in repository] B --> C1[examples-review-findings.md] B --> C2[examples-review.md] B --> C3[operations-guide-review.md] B --> C4[pr-88-comments-checklist.md] B --> C5[pr-88-triage.md] C1 & C2 & C3 & C4 & C5 --> D[PR #122 deletes all 5 files] D --> E[spec/comprehensive-documentation/ removed\nNo functional changes]Reviews (1): Last reviewed commit: "Remove PR #88 review scratch docs" | Re-trigger Greptile