reverse-skills-max: initial public release (restored, redacted, hardened)
This commit is contained in:
102
reverse-skill-repo/skills/docs-generator/references/templates.md
Normal file
102
reverse-skill-repo/skills/docs-generator/references/templates.md
Normal file
@@ -0,0 +1,102 @@
|
||||
# Documentation Templates
|
||||
|
||||
## Contents
|
||||
|
||||
- [README.md](#readmemd)
|
||||
- [API Endpoint Documentation](#api-endpoint-documentation)
|
||||
- [File System Organization](#file-system-organization)
|
||||
|
||||
## README.md
|
||||
|
||||
```markdown
|
||||
# Project Name
|
||||
|
||||
One-line description of what this does.
|
||||
|
||||
## Quick Start
|
||||
|
||||
\`\`\`bash
|
||||
yarn install && yarn dev
|
||||
\`\`\`
|
||||
|
||||
## Installation
|
||||
|
||||
Step-by-step setup.
|
||||
|
||||
## Usage
|
||||
|
||||
\`\`\`typescript
|
||||
import { thing } from "package";
|
||||
const result = thing.doSomething();
|
||||
\`\`\`
|
||||
|
||||
## Configuration
|
||||
|
||||
| Variable | Required | Default | Description |
|
||||
| --------- | -------- | ------- | ------------ |
|
||||
| `API_KEY` | Yes | - | Your API key |
|
||||
|
||||
## Documentation
|
||||
|
||||
- [API Reference](./docs/api/README.md)
|
||||
- [Architecture](./docs/architecture/overview.md)
|
||||
```
|
||||
|
||||
## API Endpoint Documentation
|
||||
|
||||
```markdown
|
||||
# Resource Name
|
||||
|
||||
Brief description.
|
||||
|
||||
## GET /resource
|
||||
|
||||
Retrieves resources.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
| ------- | ------ | -------- | ------------------------- |
|
||||
| `limit` | number | No | Max results (default: 20) |
|
||||
|
||||
**Response**
|
||||
|
||||
\`\`\`json
|
||||
{
|
||||
"data": [...],
|
||||
"total": 100
|
||||
}
|
||||
\`\`\`
|
||||
|
||||
**Example**
|
||||
|
||||
\`\`\`typescript
|
||||
const { data } = await api.get("/resource", { limit: 10 });
|
||||
\`\`\`
|
||||
|
||||
**Errors**
|
||||
|
||||
| Status | Code | Description |
|
||||
| ------ | ---------------- | ------------------------ |
|
||||
| 400 | `INVALID_PARAMS` | Invalid query parameters |
|
||||
| 401 | `UNAUTHORIZED` | Missing or invalid auth |
|
||||
```
|
||||
|
||||
## File System Organization
|
||||
|
||||
```
|
||||
/docs
|
||||
├── README.md # Docs index
|
||||
├── /api
|
||||
│ ├── README.md # API overview
|
||||
│ ├── authentication.md
|
||||
│ └── {resource}.md
|
||||
├── /architecture
|
||||
│ ├── overview.md
|
||||
│ └── data-flow.md
|
||||
├── /guides
|
||||
│ ├── getting-started.md
|
||||
│ └── troubleshooting.md
|
||||
└── /features
|
||||
└── {NNN}-{feature}.md
|
||||
```
|
||||
Reference in New Issue
Block a user