diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f7b4d74..8fc3b1c 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -13,6 +13,9 @@ on: - 'LICENSE' - 'SECURITY.md' - 'CHANGELOG.md' + - 'AGENTS.md' + - 'CLAUDE.md' + - '**/SKILL.md' tags: - 'v*' workflow_dispatch: diff --git a/AGENTS.md b/AGENTS.md index 4aa9cfb..8e39c64 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,4 +1,5 @@ # AGENTS.md + Guidance for AI agents (including Claude Code) working in this repository. ## Project Overview @@ -25,7 +26,7 @@ It is a direct port of [FlaskAPI Guard](https://github.com/rennf93/flaskapi-guar DjAPI Guard is a **thin adapter** over [guard-core](https://github.com/rennf93/guard-core). All security logic (models, handlers, decorators, detection engine, protocols, utilities) lives in the `guard_core` package; this repo contains only the Django integration layer. -``` +```text guard-core (engine, PyPI dependency >=3.15.0) <- all security logic └── djangoapi-guard (this repo) <- Django middleware adapter ├── fastapi-guard <- sibling adapter (ASGI middleware) diff --git a/CLAUDE.md b/CLAUDE.md index 4aa9cfb..8e39c64 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,4 +1,5 @@ # AGENTS.md + Guidance for AI agents (including Claude Code) working in this repository. ## Project Overview @@ -25,7 +26,7 @@ It is a direct port of [FlaskAPI Guard](https://github.com/rennf93/flaskapi-guar DjAPI Guard is a **thin adapter** over [guard-core](https://github.com/rennf93/guard-core). All security logic (models, handlers, decorators, detection engine, protocols, utilities) lives in the `guard_core` package; this repo contains only the Django integration layer. -``` +```text guard-core (engine, PyPI dependency >=3.15.0) <- all security logic └── djangoapi-guard (this repo) <- Django middleware adapter ├── fastapi-guard <- sibling adapter (ASGI middleware) diff --git a/pyproject.toml b/pyproject.toml index 9e8cff0..7d90772 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -134,6 +134,10 @@ plugins = ["mypy_django_plugin.main"] [tool.django-stubs] django_settings_module = "tests.settings" +[tool.pymarkdown.extensions] +# Enable YAML front matter parsing (agent skill files use front matter) +front-matter = {enabled = true} + [tool.pymarkdown.plugins.md007] enabled = true indent = 2