mirror of
https://github.com/duthaho/claudekit.git
synced 2026-07-29 16:11:00 +03:00
feat: migrate commands to skills
This commit is contained in:
@@ -0,0 +1,44 @@
|
||||
# API Documentation Patterns
|
||||
|
||||
## Endpoint Documentation Template
|
||||
|
||||
```markdown
|
||||
## POST /api/orders
|
||||
|
||||
Create a new order.
|
||||
|
||||
### Authentication
|
||||
Requires Bearer token.
|
||||
|
||||
### Request Body
|
||||
| Field | Type | Required | Description |
|
||||
|-------|------|----------|-------------|
|
||||
| items | array | yes | Order items |
|
||||
| shippingAddress | object | yes | Delivery address |
|
||||
|
||||
### Response (201 Created)
|
||||
```json
|
||||
{
|
||||
"id": "order_456",
|
||||
"status": "pending",
|
||||
"total": 99.99,
|
||||
"createdAt": "2024-01-15T10:00:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
### Errors
|
||||
| Status | Code | Description |
|
||||
|--------|------|-------------|
|
||||
| 400 | INVALID_ITEMS | Items array is empty |
|
||||
| 401 | UNAUTHORIZED | Invalid or missing token |
|
||||
| 422 | OUT_OF_STOCK | Item not available |
|
||||
```
|
||||
|
||||
## Discovery Process
|
||||
|
||||
1. Scan route definitions (`@app.get`, `router.post`, `@Controller`)
|
||||
2. Identify HTTP methods and paths
|
||||
3. Note authentication requirements
|
||||
4. Document request/response schemas
|
||||
5. List all error responses with codes
|
||||
6. Add working curl/httpx examples
|
||||
@@ -0,0 +1,52 @@
|
||||
# Code Documentation Patterns
|
||||
|
||||
## Python Docstrings (Google Style)
|
||||
|
||||
```python
|
||||
def calculate_discount(price: float, percentage: float) -> float:
|
||||
"""Calculate discounted price.
|
||||
|
||||
Args:
|
||||
price: Original price in dollars.
|
||||
percentage: Discount percentage (0-100).
|
||||
|
||||
Returns:
|
||||
The discounted price.
|
||||
|
||||
Raises:
|
||||
ValueError: If percentage is not between 0 and 100.
|
||||
|
||||
Example:
|
||||
>>> calculate_discount(100.0, 20)
|
||||
80.0
|
||||
"""
|
||||
```
|
||||
|
||||
## TypeScript JSDoc
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* Calculate discounted price.
|
||||
*
|
||||
* @param price - Original price in dollars
|
||||
* @param percentage - Discount percentage (0-100)
|
||||
* @returns The discounted price
|
||||
* @throws {RangeError} If percentage is not between 0 and 100
|
||||
*
|
||||
* @example
|
||||
* calculateDiscount(100, 20); // returns 80
|
||||
*/
|
||||
```
|
||||
|
||||
## When to Add Inline Comments
|
||||
|
||||
- Explain **why**, not what — `# Retry 3x because upstream API is flaky`
|
||||
- Document workarounds — `// Safari doesn't support this API, fallback to...`
|
||||
- Clarify non-obvious logic — `# O(1) amortized via lazy deletion`
|
||||
- Mark TODOs with context — `# TODO(#123): remove after migration complete`
|
||||
|
||||
## When NOT to Comment
|
||||
|
||||
- Restating the code: `i += 1 # increment i by 1`
|
||||
- Obvious function names: `def get_user_by_id` needs no docstring explaining it gets a user by ID
|
||||
- Commented-out code — delete it, git has history
|
||||
@@ -0,0 +1,43 @@
|
||||
# Project Documentation Patterns
|
||||
|
||||
## README Structure
|
||||
|
||||
```markdown
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install my-package
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
```typescript
|
||||
import { Client } from 'my-package';
|
||||
const client = new Client({ apiKey: 'your-key' });
|
||||
const result = await client.fetch();
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
|--------|------|---------|-------------|
|
||||
| `apiKey` | string | required | Your API key |
|
||||
| `timeout` | number | 5000 | Request timeout in ms |
|
||||
```
|
||||
|
||||
## Key Sections
|
||||
|
||||
1. **Title + one-liner** — what this project does
|
||||
2. **Installation** — copy-pasteable setup commands
|
||||
3. **Quick Start** — working example in < 10 lines
|
||||
4. **Configuration** — table of options with types and defaults
|
||||
5. **API Reference** — link to detailed docs
|
||||
6. **Contributing** — how to contribute
|
||||
7. **License** — MIT, Apache, etc.
|
||||
|
||||
## Documentation Coverage Report
|
||||
|
||||
After documenting, summarize:
|
||||
- Functions documented: X/Y (Z%)
|
||||
- Endpoints documented: X/Y (Z%)
|
||||
- Missing: [list of undocumented items]
|
||||
Reference in New Issue
Block a user