| 1 | import type { DocsWorkDict } from "../types"; |
| 2 | |
| 3 | /** |
| 4 | * English reference dictionary for `app/[locale]/docs/work/page.tsx` |
| 5 | * ("Track progress"). Checked against docs/GUIDE.md (workbar), docs/MODES.md |
| 6 | * (goals), docs/TOOL_SURFACE.md (the To-do list is the one progress ledger), |
| 7 | * and the `/workbar`, `/goal`, and `/relay` command definitions. |
| 8 | */ |
| 9 | export const docsWork: DocsWorkDict = { |
| 10 | metaTitle: "Track progress · Codewhale Docs", |
| 11 | metaDescription: |
| 12 | "Follow a multi-step task in the workbar: the goal, the To-do list, and sub-agents. Set a goal that lasts across turns, and hand the work to a fresh session without losing your place.", |
| 13 | bodyClassName: "text-ink-soft leading-relaxed", |
| 14 | title: "Track progress", |
| 15 | lede: |
| 16 | "When a task takes more than one step, Codewhale keeps a To-do list and shows it in the workbar, next to the goal and any sub-agents. You can see what is done, what is in progress, and what is left, while the transcript keeps scrolling.", |
| 17 | sections: [ |
| 18 | { |
| 19 | id: "workbar", |
| 20 | title: "Read the workbar", |
| 21 | blocks: [ |
| 22 | { |
| 23 | p: "The workbar sits under the composer by default. It holds the active goal, the To-do list, and the sub-agents working for this session. Finished items stay visible as done instead of disappearing. Select a row, or press Enter on it, to open its detail.", |
| 24 | }, |
| 25 | { |
| 26 | rows: [ |
| 27 | ["pending", "Not started yet."], |
| 28 | ["in progress", "What Codewhale is doing now — one item at a time."], |
| 29 | ["completed", "Done."], |
| 30 | ["cancelled", "Dropped, and kept in the list so you can see it was."], |
| 31 | ], |
| 32 | }, |
| 33 | { p: "Move it or change what it shows:" }, |
| 34 | { code: "/workbar left\n/workbar bottom --save\n/workbar off", lang: "Codewhale" }, |
| 35 | { |
| 36 | p: "Positions are `bottom`, `top`, `left`, `right`, and `off`. `--save` keeps your choice for future sessions.", |
| 37 | }, |
| 38 | ], |
| 39 | }, |
| 40 | { |
| 41 | id: "goal", |
| 42 | title: "Set a goal that lasts across turns", |
| 43 | blocks: [ |
| 44 | { |
| 45 | p: "A goal keeps one objective in view until it is met. Set it yourself, or let Codewhale set one when you ask for a clear end state, such as “until the tests pass.” It then shows one line saying so, and you stay in control:", |
| 46 | }, |
| 47 | { |
| 48 | code: `/goal make the CLI tests pass on Windows budget: 200000 |
| 49 | /goal # show progress |
| 50 | /goal pause |
| 51 | /goal resume |
| 52 | /goal done |
| 53 | /goal clear`, |
| 54 | lang: "Codewhale", |
| 55 | }, |
| 56 | { |
| 57 | p: "The optional `budget:` is a token limit for the goal. A goal does not change your mode, approval setting, or model.", |
| 58 | }, |
| 59 | ], |
| 60 | }, |
| 61 | { |
| 62 | id: "relay", |
| 63 | title: "Continue in a fresh session", |
| 64 | blocks: [ |
| 65 | { |
| 66 | p: "When a session gets long, `/relay` writes a handoff for a new thread, including the current To-do list exactly as it stands, so the next session starts from where you really are rather than a summary of it. Add a focus to steer the handoff:", |
| 67 | }, |
| 68 | { code: "/relay finish the Windows test fixes", lang: "Codewhale" }, |
| 69 | { |
| 70 | p: "Sub-agents started with the parent's context receive the same list, so they also know what is already done.", |
| 71 | }, |
| 72 | ], |
| 73 | }, |
| 74 | { |
| 75 | id: "one-list", |
| 76 | title: "Know which list counts", |
| 77 | blocks: [ |
| 78 | { |
| 79 | p: "There is exactly one progress list: the To-do. A plan Codewhale writes out — its approach, risks, and checks — explains how it will work but does not track progress, and the workbar does not show it as a second list.", |
| 80 | }, |
| 81 | { |
| 82 | p: "The list in the workbar is for you. Codewhale sees its own updates as ordinary results in the conversation; the list is not re-sent to the model on every step.", |
| 83 | }, |
| 84 | ], |
| 85 | }, |
| 86 | ], |
| 87 | next: [ |
| 88 | { |
| 89 | href: "/docs/subagents", |
| 90 | label: "Run agents in parallel", |
| 91 | note: "Hand independent To-do items to sub-agents.", |
| 92 | }, |
| 93 | { |
| 94 | href: "/docs/modes", |
| 95 | label: "Set modes and approvals", |
| 96 | note: "Operate plans named steps and checks each result.", |
| 97 | }, |
| 98 | { |
| 99 | href: "/docs/review", |
| 100 | label: "Review what changed", |
| 101 | note: "Check the work behind each completed item.", |
| 102 | }, |
| 103 | ], |
| 104 | sourceNote: |
| 105 | "Source documents: docs/GUIDE.md, docs/MODES.md, docs/TOOL_SURFACE.md, docs/TOOL_LIFECYCLE.md · Update docs-map.ts when changing.", |
| 106 | }; |
| 107 |