Skip to content

docs: fix pymarkdown violations in agent-guidance files - #21

Merged
rennf93 merged 2 commits into
masterfrom
fix/docs-lint-agents-md
Sep 24, 2026
Merged

rennf93 merged 2 commits into
masterfrom
fix/docs-lint-agents-md

Conversation

@rennf93

@rennf93 rennf93 commented Sep 24, 2026

Copy link
Copy Markdown
Member

Summary

Fixes the failing Docs Update workflow caused by pymarkdownlnt violations in the agent-guidance files.

Violations fixed (from the failed Docs Update run):

  • AGENTS.md:1:1 and CLAUDE.md:1:1 MD022 (blanks-around-headings): added the missing blank line below the top-level heading
  • AGENTS.md:28:1 and CLAUDE.md:28:1 MD040 (fenced-code-language): added a text language hint to the ecosystem diagram fence
  • djangoapi_guard/.agents/skills/djapi-guard/SKILL.md MD022 / MD026 / MD003 (8 hits): enabled the pymarkdownlnt front-matter extension in pyproject.toml so the YAML front matter in the skill file is parsed as metadata instead of a setext heading. This matches the configuration already used by tornadoapi-guard; the SKILL.md front matter itself is required by the agent skill format and cannot be removed

Also adds AGENTS.md, CLAUDE.md, and **/SKILL.md to the Docs Update workflow path filters so the workflow re-runs on the exact files it lints (it previously only ran on docs/** and a few root files, so agent-guidance edits silently skipped linting).

No code, dependency, or version changes.

@rennf93 rennf93 added the no-issue PR not linked to an issue label Sep 24, 2026
@coderabbitai

coderabbitai Bot commented Sep 24, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: c72c1f18-3e17-455e-a8d2-c9dbd2776e13


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.

@github-actions

Copy link
Copy Markdown
Contributor

Thanks for opening your first pull request on djangoapi-guard!

Quick checklist before review (most of these are enforced by CI, but worth a glance):

  • make lint — ruff format, ruff check, mypy, and vulture
  • make test (or make local-test) — full test suite passes with 100% coverage
  • make security — bandit, safety, and pip-audit all clean
  • make quality — radon and xenon complexity thresholds respected
  • No # noqa / # type: ignore shortcuts; pre-existing violations in touched files are fixed
  • Added an entry under ## Unreleased in CHANGELOG.md
  • If you touched a public API, updated the relevant page under docs/
  • If the change involves engine logic, the corresponding fix landed in guard-core first

See CONTRIBUTING.md for the full workflow and the Code of Conduct for the community standards we follow.

Welcome aboard — a maintainer will review shortly.

@github-actions github-actions Bot added ci GitHub Actions and pre-commit dependencies pyproject.toml or uv.lock labels Sep 24, 2026
@rennf93
rennf93 merged commit dfb2025 into master Sep 24, 2026
12 checks passed
@rennf93
rennf93 deleted the fix/docs-lint-agents-md branch September 27, 2026 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci GitHub Actions and pre-commit dependencies pyproject.toml or uv.lock no-issue PR not linked to an issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant