Documentation Index
Fetch the complete documentation index at: https://docs.oktolabs.ai/llms.txt
Use this file to discover all available pages before exploring further.
UI workflow map
The bundled web app lives in okto-pulse/frontend/src. It is a board-first operational UI, not a marketing shell: a selected board owns the main tabs, while global overlays expose analytics, KG, agents, settings, and help.
This page maps the visible workflows to frontend components and backend route families so an operator can find the right docs without reading the React source.
Main board tabs
Source: frontend/src/App.tsx.
| UI tab | Component | Backend surface | What it manages |
|---|
| Ideations | IdeationsPanel | /api/v1/boards/{board_id}/ideations, /api/v1/ideations/{id} | Create, evaluate, update, move, and derive specs from ideations. |
| Refinements | RefinementsPanel | /api/v1/ideations/{id}/refinements, /api/v1/refinements/{id} | Evidence gathering, refinement Q&A, snapshots, knowledge, and spec derivation. |
| Specs | SpecsPanel | /api/v1/boards/{board_id}/specs, /api/v1/specs/{id} | Spec contract editing, validation, tests, rules, contracts, TRs, decisions, mockups, architecture, KG validation, knowledge, sprints, and cards. |
| Sprints | SprintsPanel | /api/v1/boards/{board_id}/sprints, /api/v1/sprints/{id} | Sprint scope, assigned cards, evaluations, Q&A, and history. |
| Tasks | KanbanBoard | /api/v1/boards/{board_id}/cards, /api/v1/cards/{id} | Kanban card execution, dependency tracking, test/bug linkage, validation, conclusions, Q&A, comments, activity, architecture, and card knowledge. |
frontend/src/components/layout/Header.tsx.
| Overlay | Component | Backend surface | Purpose |
|---|
| Knowledge Graph | KnowledgeGraphPage | /api/v1/kg/* | Graph canvas, node details, global search, pending queue, audit log, relevance histogram, dead-letter inspection, retry, boost, and KG health. |
| Analytics | AnalyticsPage | /api/v1/analytics/*, /api/v1/boards/{board_id}/analytics/* | Overview dashboard, board dashboard, entity detail, velocity, quality, coverage, validation, blockers, and exports. |
| Agents | AgentsModal | /api/v1/agents, /api/v1/presets, /api/v1/me/permissions | Personal agents, board access, API key regeneration, permission presets, and board overrides. |
| Board settings | Board panel launched from header | /api/v1/boards/{board_id}, /api/v1/boards/{board_id}/shares, /api/v1/guidelines | Board metadata, shares, and board/global guidelines. |
| Runtime settings | RuntimeSettingsPanel | /api/v1/settings/runtime, /api/v1/kg/settings, /api/v1/kg/boards/{board_id}/settings | Graph DB sizing, event queue settings, decay tick tuning, and restart-required visibility. |
| Help | HelpPanel, KGHelpModal | static UI content | In-app guidance that mirrors the docs and KG page behavior. |
Modal tabs by artifact
Ideation modal
Source: frontend/src/components/ideations/IdeationModal.tsx.
| Tab | Purpose |
|---|
| Details | Ideation title, description, labels, complexity, and status. |
| Mockups | Screen mockups attached before refinement/spec work. |
| Architecture | Architecture designs attached to the ideation. |
| Q&A | Ambiguity-killer questions and answers. |
| Versions | Historical snapshots. |
| History | Status and edit history. |
| Refinements | Child refinements derived from the ideation. |
Refinement modal
Source: frontend/src/components/refinements/RefinementModal.tsx.
| Tab | Purpose |
|---|
| Details | Refinement description, evidence, status, and labels. |
| Mockups | Refinement-level mockups. |
| Architecture | Refinement-level architecture designs. |
| Knowledge | Evidence entries gathered during refinement. |
| Versions | Historical snapshots. |
| History | Status and edit history. |
| Q&A | Refinement questions and answers. |
| Specs | Specs derived from the refinement. |
Spec modal
Source: frontend/src/components/specs/SpecModal.tsx.
| Tab | Purpose |
|---|
| Details | Scope, requirements, acceptance criteria, and status. |
| Tests | Test scenarios and task linkage. |
| Rules | Business rules and FR linkage. |
| Contracts | API contracts and task linkage. |
| TRs | Technical requirements and task linkage. |
| Decisions | Decisions, revocation/supersedence, and linked tasks. |
| Mockups | Spec-level screen mockups. |
| Architecture | Spec-level architecture designs and copy-to-card source. |
| Validation | Spec validation gate history. |
| KG | KG validation and related graph context. |
| History | Spec changes and status moves. |
| Q&A | Spec questions and answers. |
| Knowledge | Spec knowledge entries. |
| Sprints | Sprints created from the spec. |
| Cards | Cards linked to the spec. |
Sprint modal
Source: frontend/src/components/sprints/SprintModal.tsx.
| Tab | Purpose |
|---|
| Details | Sprint title, objective, expected outcome, and status. |
| Scope | Spec scope and sprint boundaries. |
| Cards | Assigned and unassigned task cards. |
| Evaluations | Sprint evaluation gate entries. |
| Q&A | Sprint questions and answers. |
| History | Sprint changes and status moves. |
Card modal
Source: frontend/src/components/kanban/CardModal.tsx.
| Tab | Purpose |
|---|
| Details | Card description, priority, status, assignee, labels, dependencies, and bug fields. |
| Tests | Bug/test scenario linkage and evidence. |
| Mockups | Mockups copied from spec or attached to the card. |
| Architecture | Card-level architecture copied from spec or written directly. |
| Knowledge | Card knowledge entries copied from spec/refinement or added during execution. |
| Q&A | Card-specific questions and answers. |
| Comments | Text comments and choice boards. |
| Conclusion | Executor conclusion, completeness, and drift justification. |
| Validations | Task validation gate history. |
| Activity | Activity log for card-visible changes. |
KG page surfaces
Source: frontend/src/components/knowledge/KnowledgeGraphPage.tsx.
| View/control | Backend surface | Purpose |
|---|
| Graph canvas and node details | /api/v1/kg/boards/{board_id}/graph, /nodes/{node_id} | Browse graph nodes and edges. |
| Global search | /api/v1/kg/global/search | Search durable cross-board discovery context. |
| Pending queue | /api/v1/kg/boards/{board_id}/pending, /pending/tree | Inspect queued consolidation work. |
| Dead-letter inspector | /api/v1/kg/queue/dead-letter, /pending/{queue_entry_id}/retry | Inspect and reprocess failed work. |
| Audit log | /api/v1/kg/boards/{board_id}/audit, /audit/export, /audit/{session_id}/undo | Review and undo committed consolidation sessions. |
| Settings | /api/v1/kg/settings, /api/v1/kg/boards/{board_id}/settings | Read and tune KG settings. |
| Health and refresh | /api/v1/kg/health, /api/v1/kg/tick/run-now | Check freshness and manually trigger decay ticks. |
Onboarding and terms
Source: frontend/src/components/onboarding/* and frontend/src/components/onboarding/TermsAcceptanceModal.tsx.
| Flow | Purpose |
|---|
| Welcome | Introduces the local board and MCP connection. |
| Quick start | Walks the first board/agent workflow. |
| Start ideation | Starts the first problem statement. |
| Assistant binding | Points the user at MCP agent setup. |
| Terms acceptance | Requires reading and acceptance unless OKTO_PULSE_TERMS_ACCEPTED=1 or CLI --accept-terms pre-accepted. |
