dew/docs/config.md
Chris Hendrickson 0723c7d996 Scaffold docs, packages, and command registration
- Flesh out docs/index.md, docs/config.md, docs/features/mcp.md,
  docs/features/kanban.md with full content and aligned tables
- Fix .markdownlint-cli2.mjs config (rules were outside 'config' key)
- Add packages/mcp as a standalone MCP server package
- Update all pubspec descriptions
- Implement DewCommand + CommandRegistry in core
- Implement KanbanCommand and McpCommand stubs with registerCommands()
- Wire CLI entry point using CommandRunner + CommandRegistry
- Add 'melos run dew' script for running the CLI from workspace root
- Update tests across core, kanban, mcp packages

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-04-23 14:29:09 -04:00

69 lines
2.2 KiB
Markdown

# Dew Configuration
Dew is configured via a `dew.yaml` file stored in the `.project/` directory at the root of your project. Running `dew init .` will generate this file with sensible defaults.
## File Location
```text
your-project/
└── .project/
└── dew.yaml
```
## Full Schema
```yaml
dew:
mcp:
host: "localhost" # Hostname the MCP server binds to
port: 8080 # Port the MCP server listens on
kanban:
prefix: "PROJ" # Short prefix used for ticket IDs (e.g. PROJ-42)
ticket_types: # The types of tickets your board supports
- id: "epic"
name: "Epic"
- id: "story"
name: "Story"
- id: "task"
name: "Task"
- id: "bug"
name: "Bug"
- id: "spike"
name: "Spike"
columns: # Ordered list of columns on your Kanban board
- id: "todo"
name: "To Do"
color: "blue"
- id: "in-progress"
name: "In Progress"
color: "yellow"
- id: "done"
name: "Done"
color: "green"
```
## Reference
### `dew.mcp`
| Field | Type | Default | Description |
| ------ | ------- | ------------- | --------------------------------- |
| `host` | string | `"localhost"` | Hostname the MCP server binds to. |
| `port` | integer | `8080` | Port the MCP server listens on. |
### `dew.kanban`
| Field | Type | Description |
| -------------- | ------ | ------------------------------------------------------------------------------------------------------------ |
| `prefix` | string | Short uppercase prefix prepended to ticket IDs (e.g. `PROJ-1`). |
| `ticket_types` | list | The ticket types available on the board. Each entry requires an `id` and a `name`. |
| `columns` | list | The columns on the board, in order from left to right. Each entry requires an `id`, a `name`, and a `color`. |
#### Column colors
The following named colors are supported for column display:
`red`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `grey`