// 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 Docusaurus format — covers config, directory structure, frontmatter conventions, and build commands.
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 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-plain-markdown |
| description | Use when generating or auditing documentation in plain Markdown format — covers config, directory structure, frontmatter conventions, and build commands. |
Detected when:
docs/ directory exists containing .md files, ANDREADME.md existsdocs/ if it existsREADME.md) otherwisedocs/
├── README.md # Main documentation entry point
├── getting-started.md # Setup / quickstart guide
├── api/ # API reference docs
│ ├── module-a.md
│ └── module-b.md
├── guides/ # How-to guides
│ └── deployment.md
└── architecture.md # Architecture overview
| Source Path | Doc Path Candidates (try in order) |
|---|---|
src/auth/login.ts | docs/api/auth/login.md, docs/auth/login.md, docs/api/auth.md |
src/utils.ts | docs/api/utils.md, docs/utils.md |
lib/parser.py | docs/api/parser.md, docs/parser.md |
When generating new docs, use this structure:
# Module Name
Brief description of the module's purpose.
## Overview
What this module does and when to use it.
## API Reference
### `functionName(param1, param2)`
Description of the function.
**Parameters:**
| Name | Type | Description |
|------|------|-------------|
| param1 | `string` | Description |
| param2 | `number` | Description |
**Returns:** `ReturnType` — Description of return value.
**Example:**
\`\`\`typescript
const result = functionName("hello", 42);
\`\`\`
## See Also
- [Related Module](./related.md)
Plain Markdown has no built-in nav. The entry point is docs/README.md or README.md. Cross-linking is done via relative markdown links.