Skip to content

docs: add agent workspace user guide#95

Open
0xLeathery wants to merge 6 commits into
sybil-solutions:mainfrom
0xLeathery:docs/agent-workspace
Open

docs: add agent workspace user guide#95
0xLeathery wants to merge 6 commits into
sybil-solutions:mainfrom
0xLeathery:docs/agent-workspace

Conversation

@0xLeathery

@0xLeathery 0xLeathery commented May 25, 2026

Copy link
Copy Markdown

Hey — after the onboarding docs (#93) and recipes guide (#94), this covers the main surface users spend their time in: the agent workspace.

Depends on #93 and #94 — review after those land. The diff will clean up as each merges.

What's here

`docs/agent-workspace.md` — a user-facing guide to the `/agent` surface:

  • Projects — adding a local directory, what scope means, switching
  • Sessions — creating, tabs, persistence, surviving pane closures
  • Panes — splitting, resizing, dragging tabs between panes, layout persistence
  • The composer — `@` mentions for plugins/MCP tools, `$` mentions for skills, file attachments (drag-and-drop, paste, size limits), run lifecycle
  • The right panel — Browser (live vs reading mode, localhost discovery), Filesystem (tree browser, search, preview), Git (diff viewer, branch, commit, push, PR), Terminal (xterm.js), Canvas (shared scratchpad)
  • Settings — API connection, appearance, engines
  • Example workflow — the full loop: add project → create session → attach tools → chat → review

Also wired into `docs/README.md`.

Built from a survey of the frontend agent surface — projects, sessions, panes, composer, tools catalogue, browser panel, and settings. Docs-only, no code touched.

@0xLeathery
docs: add onboarding documentation (getting-started, environment, ope…
7f617bf 
…rations, desktop-electron, docs index)

- Add docs/getting-started.md with four self-contained install paths:
  desktop app, GPU server, mock mode, and contribute
- Add docs/environment.md with ~50 env vars across 8 concern groups
- Add docs/operations.md covering setup, deployment, daemon mode,
  remote deploy, desktop app, health checks, and troubleshooting
- Add docs/desktop-electron.md for Electron build/install/dev workflow
- Add docs/README.md as a top-level docs index
- Fix README.md: stale v1.13.0 release notes replaced with CHANGELOG
  link, wrong Docker command fixed to match docker-compose.yml,
  add getting-started link to Docs and Setup guide sections

All six cross-referenced doc links now resolve — zero dead links.
@0xLeathery 0xLeathery requested a review from 0xSero as a code owner May 25, 2026 01:48
0xLeathery added 5 commits May 25, 2026 11:52
@0xLeathery
docs: audit fixes for onboarding docs
77ed6f8 
- Replace <repo-url> placeholders with actual repo URL
- Fix GPU server path: add VLLM_STUDIO_HOST=0.0.0.0 for remote access
- Rewrite desktop-electron.md Quick Start with first-time guidance
- Add [Back to docs index] nav links to all four docs
@0xLeathery
docs: add recipe and model setup guide
3fee224 
- Add docs/recipes.md covering: creating recipes, all six backends,
  model weight sources, launch flow, multi-GPU, quantization,
  custom Python paths, mock mode, and launch troubleshooting
- Add recipes.md to docs/README.md index
- Add 'Next: set up a model' link from getting-started.md
@0xLeathery
docs: audit fixes for recipes guide
738ae5e 
- Fix bogus LIFECYCLE_READY_TIMEOUT_MS reference (hardcoded constant)
- Add agent-workspace link to next steps
- Add back-to-index nav link
@0xLeathery
docs: add agent workspace user guide
be9638c 
- Add docs/agent-workspace.md covering: projects, sessions, panes,
  composer (@mentions, \$mentions, file attachments), right panel
  (Browser, Filesystem, Git, Terminal, Canvas), settings, and an
  end-to-end workflow example
- Add agent-workspace.md to docs/README.md index
@0xLeathery
docs: audit fixes for agent workspace guide
b41cd08 
- Add 'Before you start' with link to recipes.md
- Add back-to-index nav link
@0xLeathery 0xLeathery force-pushed the docs/agent-workspace branch from 10e9e3e to b41cd08 Compare May 25, 2026 01:53
@0xSero 0xSero mentioned this pull request Jul 12, 2026
Open
@0xSero

0xSero commented Jul 12, 2026

Copy link
Copy Markdown
Collaborator

This is the doc users will lean on most, so accuracy matters double — and the workspace shifted a lot since May. The composer section is the biggest issue: @ now mentions files (plugin/tool selection moved to the + popup / tools tab), and / (prompt templates) joined $ (skills) as prefixes. The right panel grew to nine tabs (status, tools, canvas, side-chat, browser, files, diff, terminal, plan — "Git" is now "diff"), terminals became reattachable sidebar sessions, and the voice URL setting was removed along with the voice feature. Projects/sessions/panes sections hold up well, as do the attachment-limit and queued-follow-up details. Requesting changes: a re-survey of the composer and right-panel sections against frontend/src/features/agent/ would get this mergeable — I'd genuinely like to land it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@0xSero 0xSero Awaiting requested review from 0xSero 0xSero is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@0xLeathery @0xSero