59 lines
1.8 KiB
Markdown
59 lines
1.8 KiB
Markdown
# Agent Instructions
|
|
|
|
## Documentation Guidelines
|
|
|
|
When adding new features or making significant changes to this project, please follow these documentation guidelines:
|
|
|
|
### 1. Feature Documentation
|
|
- **Always document new features** in markdown files within the `docs/` directory
|
|
- Use descriptive filenames that match the feature (e.g., `youtube-downloader.md`, `transcoding.md`)
|
|
- Include the following sections in feature documentation:
|
|
- **Overview**: What the feature does
|
|
- **Usage**: How to use the feature
|
|
- **Technical Details**: Implementation details, APIs used, dependencies
|
|
- **Configuration**: Any configuration options or environment variables
|
|
- **Examples**: Code examples or usage examples
|
|
|
|
### 2. Documentation Structure
|
|
- Keep documentation files focused on a single feature or topic
|
|
- Use clear headings and formatting
|
|
- Include code examples where relevant
|
|
- Link between related documentation files when appropriate
|
|
|
|
### 3. When to Document
|
|
- Adding a new feature
|
|
- Adding a new API endpoint
|
|
- Adding a new configuration option
|
|
- Making significant changes to existing features
|
|
- Adding new dependencies or tools
|
|
|
|
### 4. File Naming Convention
|
|
- Use kebab-case for filenames (e.g., `youtube-downloader.md`)
|
|
- Be descriptive but concise
|
|
- Group related features in the same file when appropriate
|
|
|
|
### 5. Update Existing Documentation
|
|
- When modifying existing features, update the relevant documentation file
|
|
- If a feature is removed, mark it as deprecated or remove the documentation
|
|
|
|
## Example Documentation Template
|
|
|
|
```markdown
|
|
# Feature Name
|
|
|
|
## Overview
|
|
Brief description of what this feature does.
|
|
|
|
## Usage
|
|
How to use this feature.
|
|
|
|
## Technical Details
|
|
Implementation details, APIs, dependencies.
|
|
|
|
## Configuration
|
|
Any configuration options.
|
|
|
|
## Examples
|
|
Code or usage examples.
|
|
```
|