Skip to content

docs: improve README structure and clarify documentation #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dbpolito wants to merge 1 commit into from
Closed

docs: improve README structure and clarify documentation #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,29 @@

Kompass keeps AI coding agents on course with token-efficient, composable workflows.

It provides commands, agents, tools, and reusable prompt components for planning, development, review, and shipping.

## Docs

- Main docs: https://kompassdev.ai/docs/
- Docs home: https://kompassdev.ai/docs/
- Getting started: https://kompassdev.ai/docs/getting-started/
- OpenCode adapter: https://kompassdev.ai/docs/adapters/opencode/
- Config reference: https://kompassdev.ai/docs/config/overview/
- Command, agent, tool, and component reference: https://kompassdev.ai/docs/reference/commands/, https://kompassdev.ai/docs/reference/agents/, https://kompassdev.ai/docs/reference/tools/, https://kompassdev.ai/docs/reference/components/
- Command reference: https://kompassdev.ai/docs/reference/commands/
- Agent reference: https://kompassdev.ai/docs/reference/agents/
- Tool reference: https://kompassdev.ai/docs/reference/tools/
- Component reference: https://kompassdev.ai/docs/reference/components/

## Bundled Surface
## What Ships Today

- Commands cover direct work (`/ask`, `/commit`, `/merge`), orchestration (`/dev`, `/ship`, `/todo`), ticket planning/sync, and PR review/shipping flows.
- Agents are intentionally narrow: `worker` is generic, `planner` is no-edit planning, `navigator` owns multi-step orchestration, and `reviewer` is a no-edit review specialist.
- Structured tools keep workflows grounded in repo and GitHub state: `changes_load`, `command_expansion` (resolve a slash command and return the expanded prompt for immediate delegation), `pr_load`, `pr_sync`, `ticket_load`, `ticket_sync`.
- Reusable command-template components live in `packages/core/components/` and are documented in the components reference.
- Commands for direct work, orchestration, tickets, PRs, review, and shipping.
- Narrow agents with clear roles: `worker`, `planner`, `navigator`, and `reviewer`.
- Structured tools for repo and GitHub state: `changes_load`, `command_expansion`, `pr_load`, `pr_sync`, `ticket_load`, and `ticket_sync`.
- Reusable command-template components in `packages/core/components/`.

## Installation

For OpenCode, add the adapter package to your config:
OpenCode is the current adapter. Add the plugin to your config:

```json
{
Expand Down
1 change: 1 addition & 0 deletions packages/opencode/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ async function logObservedFailure(
});
}

// added by mistake
Copy link
Copy Markdown

@kompassdev kompassdev bot Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment appears to be an unintended change unrelated to the PR's documentation focus. The comment text itself acknowledges it was "added by mistake". This should be removed before merging to avoid polluting the codebase.

export async function getTaskToolExecution(
input: ToolExecuteBeforeInput,
output: ToolExecuteBeforeOutput,
Expand Down
Loading