// Use when generating or auditing documentation in MkDocs format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in Docusaurus format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in plain Markdown format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in Sphinx format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in VitePress format — covers config, directory structure, frontmatter conventions, and build commands.
Use when writing, auditing, or generating documentation for projects in unsupported languages — covers docstring conventions, API doc extraction, and generic heuristic patterns.
Use when writing, auditing, or generating documentation for Go projects — covers docstring conventions, API doc extraction, and Go-specific patterns.
| name | fw-mkdocs |
| description | Use when generating or auditing documentation in MkDocs format — covers config, directory structure, frontmatter conventions, and build commands. |
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.