Skip to content

style(docs): clear all 31 pre-existing markdownlint warnings - #222

Open
ethanolivertroy wants to merge 1 commit into
mainfrom
cursor/markdownlint-cleanup-4980
Open

style(docs): clear all 31 pre-existing markdownlint warnings#222
ethanolivertroy wants to merge 1 commit into
mainfrom
cursor/markdownlint-cleanup-4980

Conversation

@ethanolivertroy

Copy link
Copy Markdown
Collaborator

Summary

Clears every pre-existing markdownlint warning so the pre-commit lint is fully green: npx markdownlint-cli2@0.18.1 now reports 0 errors across 416 files (previously 31 warnings across 8 files).

  • MD022 (23): blank lines added around headings in grc-portfolio, trust-center, and cmmc docs (auto-fix).
  • MD026 (5): trailing colons removed from the component-list headings in grc-portfolio/skills/website-build/SKILL.md (auto-fix).
  • MD025/MD001 (3): the two mid-document H1 "part divider" headings in cmmc/skills/cmmc-assessment-objectives/SKILL.md (320 Assessment Objectives, Rev 2 → Rev 3 Control Crosswalk) demoted to H2. The document's dominant section style is already H2, and this also fixes the illegal h1-to-h3 increment at the crosswalk's Summary subheading. No content changes.

Type of change

  • Connector
  • Framework plugin
  • Persona plugin
  • Documentation
  • Community / governance
  • CI / automation
  • Other

Schema impact

  • No schema changes
  • schemas/finding.schema.json changed
  • Another schema or contract surface changed

Test plan

$ npx markdownlint-cli2@0.18.1
Linting: 416 file(s)
Summary: 0 error(s)

$ npm run test:grc-diagrams
GRC diagram plugin skill/command surface is valid.

$ npm run test:plugin-manifests
Validated 66 manifest(s). All manifests valid.

CHANGELOG

  • No CHANGELOG entry needed
  • I added a CHANGELOG entry
  • A maintainer should add the CHANGELOG entry during merge

Notes for reviewers

Once this lands, the "note the repo currently has some pre-existing MD022 warnings" caveat in AGENTS.md becomes stale. #216 already edits that same line, so the caveat removal is left to a one-word follow-up in whichever lands second, to avoid manufacturing a conflict between the two PRs.

Open in Web Open in Cursor 

- MD022: blank lines around headings (grc-portfolio, trust-center, cmmc)
- MD026: trailing colons removed from grc-portfolio component headings
- MD025/MD001: the two mid-document H1 part dividers in the cmmc
  assessment-objectives skill demoted to H2, matching the doc's
  dominant H2 section style and fixing the h1-to-h3 increment jump

markdownlint-cli2 now reports 0 errors across 416 files.

Co-authored-by: Ethan Troy <ethanolivertroy@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@ethanolivertroy, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 59 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 1aacbab5-3cf8-4b3a-af89-60232b2d9623

📥 Commits

Reviewing files that changed from the base of the PR and between e98e63e and 0cde5a0.

📒 Files selected for processing (8)
  • plugins/frameworks/cmmc/skills/cmmc-assessment-objectives/SKILL.md
  • plugins/grc-portfolio/skills/website-build/SKILL.md
  • plugins/grc-portfolio/skills/website-preflight/SKILL.md
  • plugins/trust-center/commands/add-document.md
  • plugins/trust-center/commands/deploy.md
  • plugins/trust-center/commands/init.md
  • plugins/trust-center/commands/status.md
  • plugins/trust-center/skills/trust-center/SKILL.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@greptile-apps

greptile-apps Bot commented Aug 7, 2026

Copy link
Copy Markdown

Greptile Summary

This documentation-only PR resolves markdownlint warnings without changing instructional content or runtime behavior.

  • Adds required blank lines around Markdown headings.
  • Removes trailing punctuation from component-list headings.
  • Demotes two mid-document CMMC H1 headings to H2 for a valid hierarchy.

Confidence Score: 5/5

The PR appears safe to merge because the changes are limited to Markdown formatting and valid heading normalization.

The edited files retain their original instructions and content while correcting blank-line, trailing-punctuation, and heading-level lint violations; no blocking or non-blocking defect remains.

Important Files Changed

Filename Overview
plugins/frameworks/cmmc/skills/cmmc-assessment-objectives/SKILL.md Demotes two section dividers from H1 to H2 and adds one heading-adjacent blank line, preserving content and improving hierarchy.
plugins/grc-portfolio/skills/website-build/SKILL.md Removes trailing colons from headings and inserts markdownlint-required blank lines without altering skill instructions.
plugins/grc-portfolio/skills/website-preflight/SKILL.md Adds blank lines beneath report-section headings with no behavioral change.
plugins/trust-center/skills/trust-center/SKILL.md Adds blank lines between provider headings and their lists without changing provider guidance.
plugins/trust-center/commands/add-document.md Adds heading-adjacent blank lines only.
plugins/trust-center/commands/deploy.md Adds heading-adjacent blank lines only.
plugins/trust-center/commands/init.md Adds heading-adjacent blank lines only.
plugins/trust-center/commands/status.md Adds heading-adjacent blank lines only.

Reviews (1): Last reviewed commit: "style(docs): clear all 31 pre-existing m..." | Re-trigger Greptile

@ethanolivertroy
ethanolivertroy marked this pull request as ready for review August 7, 2026 12:47
@ethanolivertroy
ethanolivertroy requested a review from a team as a code owner August 7, 2026 12:47
@qodo-code-review

Copy link
Copy Markdown

ⓘ Qodo reviews are paused because the subscription is no longer active. Ask your workspace admin to reactivate the subscription to resume reviews. Manage billing

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.

2 participants