mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-11-12 14:00:35 +00:00
2a97ec3e58
* docs: turn README into an index and move reference detail to docs/guide The README had grown to 393 KB because every change appended its notes there. The text moves verbatim into 18 topic guides under docs/guide/; only headings are re-leveled and relative links re-pointed. The README keeps the introduction, a quick start and a guide index. Contributor test notes move to CONTRIBUTING.md. * docs: send user docs to topic guides and budget the root README The rule 'update README.md for user-facing changes' is what grew the README. Guidance now points to docs/guide/, and check_agent_guidance.py fails when the root README exceeds 16 KiB (AG003). * chore: remove unreferenced screenshots and finished plan notes pr-build/ holds two PR screenshots (3 MB) from #1986. plans/ holds the plan for the merged #4049. docs/SKILL_NAME_CONFLICT_FIX.md is a February change note. Nothing references them. * docs: route always-loaded AGENTS.md files to scoped guides * docs(agents): cut scoped guides to scope, verify, traps, decisions Each AGENTS.md keeps four kinds of content: the scope of the directory, the verification commands, traps a local test run does not show, and decisions the code cannot state. Values, field lists, function inventories, test names, issue numbers and history are deleted, because the code, the tests and git state them. Search and fetch providers share one community guide. Four guides with no remaining content are removed. The size check now allows 6 KiB per file (hard limit 8 KiB) and 24 KiB per chain (hard limit 32 KiB). * style: format frontend guide table and guidance test imports --------- Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
40 lines
2.6 KiB
Markdown
40 lines
2.6 KiB
Markdown
# Workspace UI
|
|
|
|
## Token usage dashboard
|
|
|
|
Open **Token usage** in the workspace sidebar (`/workspace/usage`) to review
|
|
your recorded tokens over the last 7 or 30 days, daily input/output totals,
|
|
cache-hit input tokens by model, and paginated run history with failure filters.
|
|
Run history covers all dates independently of the selected chart period.
|
|
Conversation links use each run's recorded assistant to open the default or
|
|
matching custom-agent chat.
|
|
Periods with no recorded runs show an empty message without a date axis or
|
|
zero-filled daily details; runs with zero reported tokens still show details.
|
|
|
|
Reporting requires `runs:read` permission and a SQLite or PostgreSQL database;
|
|
it is unavailable in the static demo. Counts reflect persisted provider usage,
|
|
may be incomplete during active runs or when providers omit usage, and are not
|
|
a provider bill. Cache hits are included in input tokens. Daily buckets use the
|
|
browser's current UTC offset and attribute a run to its creation date.
|
|
The page reuses the existing `/api/console` APIs; their optional cost and currency
|
|
fields and server-side pricing configuration remain supported.
|
|
See [dashboard behavior and design](../../frontend/docs/token-usage-dashboard.md).
|
|
|
|
## Workspace
|
|
|
|
The workspace keeps a collapsed icon sidebar visible on narrow screens. Its
|
|
toggle opens the full navigation drawer; closing the drawer returns to the icon
|
|
bar without changing your saved desktop sidebar preference. Navigating to another
|
|
page also closes the mobile drawer and preserves the destination page's focus.
|
|
Dismissing the drawer returns keyboard focus to the control that opened it.
|
|
The Agents gallery header wraps to the available width so its import and create
|
|
actions remain visible beside the compact sidebar on narrow screens.
|
|
|
|
## Chat Archive
|
|
|
|
Deleting a chat from the sidebar requires confirmation showing its title. Deletion removes the conversation and its files and cannot be undone.
|
|
|
|
Use **Archive chat** in a recent chat's sidebar menu to hide completed work while keeping its messages, files, and original link. The success message offers **Undo**. Open **Chats → Archived** to find archived conversations and restore them individually; an open archived conversation also shows a restore button in its header. Search filters the titles of loaded conversations, with **Load more** for older entries.
|
|
|
|
Archive and restore preserve the chat's activity time and pinned state. Archiving does not stop a running task or pause its schedules, and new activity does not automatically restore it. Use the existing Delete action when you intend to remove a conversation and its files.
|