documentation

Documentation Rules

Documentation Requirements

All features must be documented.

Documentation is as important as code. Users should be able to understand and use features without reading the source code.

Documentation Structure

docs/
├── index.md                    # Home page
├── installation.md             # Installation guide
├── quick-start.md              # Quick start
├── usage.md                    # Usage examples
├── fl-studio-integration.md    # FL Studio integration
├── midi-integration.md         # MIDI integration
├── mcp-client-setup.md         # MCP client setup
├── configuration.md            # Configuration
├── contributing.md             # Contributing guide
├── development.md              # Development setup
├── testing.md                  # Testing guide
├── git-workflow.md             # Git workflow
├── release-process.md          # Release process
├── api/
│   ├── server.md              # Server API reference
│   └── midi.md                # MIDI API reference
└── stylesheets/
    └── extra.css              # Custom styles

Documentation Tools

MkDocs with Material theme:

# Install docs dependencies
uv sync --extra docs

# Serve locally
uv run mkdocs serve
# Visit http://localhost:8000

# Build documentation
uv run mkdocs build

# Deploy to GitHub Pages
uv run mkdocs gh-deploy --force

Writing Documentation

Use Clear Language

• Write for users, not developers
• Use simple, direct language
• Include examples
• Add code snippets where helpful

Code Examples

Always include working code examples:

## Sending a MIDI Note

```python
from fruityloops_mcp.midi_interface import MIDIInterface

# Create interface
midi = MIDIInterface()

# Connect
midi.connect()

# Send middle C
midi.send_note_on(60, 100)

# Disconnect
midi.disconnect()
```

API Documentation

Use Google-style docstrings - they're auto-generated into docs:

def my_function(param: str, count: int = 10) -> list[str]:
    """Process the parameter and return results.
    
    This function takes a string parameter and processes it
    based on the count value provided.
    
    Args:
        param: The input string to process
        count: Number of items to return, default 10
    
    Returns:
        List of processed strings
    
    Raises:
        ValueError: If param is empty
    
    Example:
        >>> my_function("test", 5)
        ['test_0', 'test_1', 'test_2', 'test_3', 'test_4']
    """
    # Implementation