Skip to content

Commit 47955fc

Browse files
dpwanjalaclaude
andcommitted
feat: add AGENT.md, /docs page, and navigation improvements
- AGENT.md: universal agent entry point (54 lines) with quickstart, discovery tiers, state machine, and common workflows - /docs page: comprehensive single-page reference with commands table, state machine, file format, agent quickstart, and configuration - Route /docs in App.tsx, add Docs link to nav and footer - Fix nav anchor links to use absolute paths (/#features etc.) - Make logo clickable to navigate home - Update footer: Syncropic Inc. Public Benefit Corporation, MIT License link - Add Documentation section and AGENT.md callout to README Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent e5e703e commit 47955fc

6 files changed

Lines changed: 417 additions & 14 deletions

File tree

AGENT.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# CatchMyTask — Agent Entry Point
2+
3+
CatchMyTask (`cmt`) is a file-first work management CLI. Work items are Markdown + YAML frontmatter in `.cmt/items/`. Git is the history layer. Agents and humans are equal actors.
4+
5+
## 30-Second Start
6+
7+
```bash
8+
export CMT_ACTOR=your-agent-name
9+
cmt help-agent --json # discover capabilities
10+
cmt list --json # see current items
11+
cmt add "Fix the bug" -p high --json
12+
cmt done PROJ-0001 --json
13+
```
14+
15+
## Rules
16+
17+
- **Always** set `CMT_ACTOR` or pass `--actor`**always** pass `--json`
18+
- **ID format**: `PREFIX-N` (e.g., `CMT-1` or `CMT-0001` — both accepted)
19+
- **Read** `.cmt/CONVENTIONS.md` for project-specific state machine and defaults
20+
- **Never edit** `.cmt/.index.db` — use `cmt reindex` if needed
21+
22+
## Discovery Tiers
23+
24+
| Tier | Command | Use When |
25+
|------|---------|----------|
26+
| 0 | `cmt help-agent --json` | First encounter |
27+
| 1 | `cmt help-agent <cmd> --json` | Per-command details |
28+
| 2 | `cmt help-agent --conventions --json` | Project conventions |
29+
| 3 | Read `SKILL.md` in repo root | Full reference |
30+
31+
## Key Files
32+
33+
`.cmt/config.yml` (config) · `.cmt/items/*.md` (active items) · `.cmt/archive/*.md` (done/cancelled)
34+
`.cmt/ABOUT.md` (project summary) · `.cmt/CONVENTIONS.md` (conventions) · `.cmt/templates/` (templates)
35+
36+
## Default State Machine
37+
38+
```
39+
inbox → ready → active → done States: inbox (initial) · ready · active
40+
↓ ↑ blocked · done (terminal) · cancelled (terminal)
41+
blocked ────┘
42+
(any) → cancelled
43+
```
44+
45+
## Common Workflows
46+
47+
```bash
48+
cmt add "Implement feature X" -p high --json # create
49+
cmt status PROJ-1 active --json # start working
50+
cmt status PROJ-1 blocked --json # block
51+
cmt search "authentication" --json # search
52+
cmt list -s active -p high --json # filter
53+
cmt check --json # validate project
54+
```

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ A work management system for humans and AI agents.
77
- **Agent-first**: AI agents and humans are equal first-class actors
88
- **Self-contained**: Single binary CLI. No runtime dependencies, no accounts, no SaaS
99

10+
## Documentation
11+
12+
- [AGENT.md](AGENT.md) — universal agent entry point (start here if you're an AI agent)
13+
- [Online Docs](https://catchmytask.com/docs) — comprehensive reference with commands, state machine, file format, and configuration
14+
1015
## Install
1116

1217
```bash
@@ -112,6 +117,8 @@ cmt setup --remove claude-code
112117

113118
## For AI Agents
114119

120+
> **Agents**: See [AGENT.md](AGENT.md) for a concise, structured entry point with everything you need to get started.
121+
115122
Set `CMT_ACTOR` to identify yourself in event logs:
116123

117124
```bash

web/src/App.tsx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
import { LandingPage } from '@/pages/Landing'
22
import { AppPage } from '@/pages/App'
3+
import { DocsPage } from '@/pages/Docs'
34

45
export function App() {
56
const path = window.location.pathname
67
if (path === '/app' || path.startsWith('/app/')) {
78
return <AppPage />
89
}
10+
if (path === '/docs' || path.startsWith('/docs/')) {
11+
return <DocsPage />
12+
}
913
return <LandingPage />
1014
}

0 commit comments

Comments
 (0)