Skip to content

[Repo Health] documentation: DSL fixes#9

Merged
stuckvgn merged 2 commits intomainfrom
health/dsl/documentation
Apr 2, 2026
Merged

[Repo Health] documentation: DSL fixes#9
stuckvgn merged 2 commits intomainfrom
health/dsl/documentation

Conversation

@stuckvgn
Copy link
Copy Markdown
Contributor

@stuckvgn stuckvgn commented Apr 2, 2026

Summary

  • Adds .pre-commit-config.yaml with a markdownlint-cli hook (v0.44.0) covering all .md files
  • Excludes .claude/ directory (agent instruction files ported from other repos — not this repo's docs)
  • Disables three rules project-wide: MD013 (line length — docs use long URLs/tables), MD033 (inline HTML), MD041 (first-line heading — subdirectory READMEs start with section headings)
  • Adds .desloppify/ to .gitignore

Pre-existing lint errors (not fixed — docs content is intentional)

Running markdownlint against existing project docs surfaces the following. These are noted here for awareness and should be addressed in follow-up PRs by document owners:

File Rule Issue
README.md MD022 Headings not surrounded by blank lines (emoji section headings)
README.md MD007 List indentation (3 spaces, expected 0)
README.md MD009 Trailing space on line 2
CLAUDE.md MD032 Lists not surrounded by blank lines
CLAUDE.md MD040 Fenced code block missing language specifier
Automation/README.md MD026 Trailing ! in heading
Generation/README.md MD009 Trailing space
Predictions/README.md MD022 Heading not surrounded by blank lines
Predictions/README.md MD009 Trailing space
Knowledge/README.md MD040 Fenced code block missing language specifier
Knowledge/README.md MD007 List indentation (4 spaces)
Knowledge/README.md MD029 Ordered list item prefix (global numbering across sections)
Knowledge/README.md MD009 Trailing space

Test plan

  • pre-commit run markdownlint --all-files runs without error on .claude/ exclusion in place
  • Hook installs and executes via python3 -m pre_commit run markdownlint --all-files
  • Future contributors: run pre-commit install after cloning to activate the hook locally

stuckvgn added 2 commits April 2, 2026 22:05
Adds .pre-commit-config.yaml with markdownlint-cli hook for .md files.
Excludes .claude/ (agent instruction files from other repos).
Disables MD013/MD033/MD041 (line length, inline HTML, first-line heading).
Adds .desloppify/ to .gitignore.
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 2, 2026

Warning

Rate limit exceeded

@stuckvgn has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 12 minutes and 13 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 12 minutes and 13 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 30b52092-f046-4546-8357-0b9e53c4cccc

📥 Commits

Reviewing files that changed from the base of the PR and between 8e4f36b and abe715e.

📒 Files selected for processing (3)
  • .gitignore
  • .pre-commit-config.yaml
  • CLAUDE.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch health/dsl/documentation

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

@stuckvgn stuckvgn merged commit 15aa79f into main Apr 2, 2026
2 checks passed
@stuckvgn stuckvgn deleted the health/dsl/documentation branch April 2, 2026 16:54
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.

1 participant