Stats
Actions
Tags
Help us improve
Share bugs, ideas, or general feedback.
From docs-guardian
Generates and audits MkDocs documentation: parses mkdocs.yml config and nav, maps code to doc pages via conventions, provides Markdown templates with Material theme admonitions.
npx claudepluginhub xiaolai/claude-plugin-marketplace --plugin docs-guardianHow this skill is triggered — by the user, by Claude, or both
Slash command
/docs-guardian:fw-mkdocsThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Detected when `mkdocs.yml` or `mkdocs.yaml` exists in project root.
Fetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.
Provides a checklist for code reviews covering functionality, security, performance, maintainability, tests, and quality. Use for pull requests, audits, team standards, and developer training.
Share bugs, ideas, or general feedback.
Detected when mkdocs.yml or mkdocs.yaml exists in project root.
Key fields to extract from mkdocs.yml:
site_name: My Project
docs_dir: docs # default: docs/
nav:
- Home: index.md
- API Reference:
- Auth: api/auth.md
- Users: api/users.md
- Guides:
- Getting Started: guides/getting-started.md
theme:
name: material # most common theme
docs_dir: the documentation root (default docs/)nav: ordered navigation structure mapping titles to file pathsnav are relative to docs_dirValue of docs_dir in mkdocs.yml, defaults to docs/.
Parse nav entries to find existing doc pages. Match source files to doc pages by:
api/ or reference/| Source | Doc Candidate |
|---|---|
src/auth/login.ts | docs/api/auth.md or docs/reference/auth/login.md |
src/models/user.py | docs/api/models/user.md or docs/reference/user.md |
MkDocs pages use standard Markdown with optional Material theme admonitions:
# Auth Module
Brief description.
## API Reference
### `login(username, password)`
Authenticates a user and returns a session token.
**Parameters:**
| Name | Type | Description |
|------|------|-------------|
| `username` | `str` | The user's login name |
| `password` | `str` | The user's password |
**Returns:** `Session` — An authenticated session object.
!!! warning
Passwords are transmitted in plaintext unless TLS is configured.
!!! example
```python
session = login("admin", "secret")
```
If using Material theme, docs may include:
!!! note/warning/tip/example admonitions::: details collapsible sections{{ var }} Jinja template variables (from mkdocs-macros-plugin)These are valid MkDocs content — do not flag as quality issues.