Skip to main content

Documentation Tracking Plan

This is a structured backlog of what still needs documentation for the Klip Extension. Each phase lists only features surfaced in the UI (sidebar, dashboard, commands, or settings), where to look in the repo, and what to verify before writing.

How to use this plan​

  • Treat each phase as a self-contained workstream.
  • Use the review instructions to gather facts before writing.
  • Add or update docs pages only after confirming behavior in code.
  • Skip code-only or dormant features that have no UI surface.

Sources of truth​

  • Extension settings: package.json (contributes.configuration)
  • Commands: package.json (contributes.commands)
  • UI implementation: src/views/*, media/webviews/*
  • Daemon behavior: daemon/src/*, crates/klip-core/*
  • Runtime logs: ~/.klip/logs/

Phase 1: Onboarding and Environment Setup​

Features:

  • CLI setup flow, environment checks, shell selection
  • First-time user experience in VS Code

Review instructions:

  • Search for setup commands and UI: rg -n "showWelcome|diagnoseEnvironment|selectShell|recheckClis" src media
  • Review onboarding screens: src/views/welcome*, media/webviews/welcome/*
  • Verify shell detection logic: crates/klip-core/src/path/platform.rs

Doc outputs:

  • Confirm CLI install guidance and where it lives in the UI.
  • Document shell preferences and supported shells.

Phase 2: Session Discovery and Data Locations​

Features:

  • Default session roots and additional paths
  • WSL discovery on Windows
  • Local data storage and what is safe to delete

Review instructions:

  • Discovery configuration: crates/klip-core/src/path/platform.rs
  • Extension settings: klip.additionalSessionPaths, klip.configPath
  • Daemon discovery args: src/services/daemon/daemonManager.ts

Doc outputs:

  • Explain path auto-detection behavior and fallback scan.
  • Add path examples for Windows, macOS, Linux, WSL.

Phase 3: Session Browsing and Resume​

Features:

  • Session list UI, details, and history viewer
  • Resume behavior, terminal launch, and session click actions
  • Archiving, renaming, and delete flows

Review instructions:

  • Sidebar and session explorer: src/views/sidebar/*, src/views/sessionsExplorer/*
  • Session detail and history: src/views/sessionDetail/*, src/views/sessionViewer/*
  • Resume handlers: src/views/sidebar/handlers/*, src/services/sessionActionService.ts

Doc outputs:

  • Explain resume flows and click behaviors.
  • Map UI actions to commands.
  • Document archive lifecycle and deletion behavior.

Phase 4: File Tracking and Exports​

Features:

  • Worked-on files list and file tracking settings
  • Backup storage and size limits
  • Export flows (session history, transcripts)

Review instructions:

  • File tracking settings: package.json (klip.fileTracking.*)
  • File tracking code: src/services/fileTracking*, src/services/sessionActionService.ts
  • UI and commands: src/views/sessionDetail/*, src/views/sessionViewer/*, src/commands/sessionCommands.ts

Doc outputs:

  • Explain what is stored locally and what is optional.
  • Provide guidance on safe cleanup.

Phase 5: Search and Embeddings​

Features:

  • Full-text search and vector search
  • Embedding provider selection and indexing behavior

Review instructions:

  • Search UI and API: src/views/SearchPanel*, src/services/daemon/*
  • Embedding initialization: daemon/src/utils.rs
  • Settings: klip.search.*, klip.ai.embeddingProvider, API keys

Doc outputs:

  • Describe when vector search is enabled.
  • Clarify reindex behavior on provider change.

Phase 6: Summaries (Models, Context, Cost)​

Features:

  • Summary generation flows (full, update, recent)
  • Model selection and context configuration

Review instructions:

  • Summary service: src/services/summaryService.ts
  • Settings: klip.defaultSummaryModel, klip.summary.*
  • UI: media/webviews/components/settings/SummariesSection.tsx

Doc outputs:

  • Explain summary modes and how context size settings affect cost.
  • Document Gemini key requirement for Gemini models.

Phase 7: KlipPanel and Terminal Experience​

Features:

  • KlipPanel layouts and persistence
  • Terminal backend selection and UI options
  • Terminal toolbar buttons (Button Library)

Review instructions:

  • KlipPanel core: src/views/klipPanel/*, media/webviews/context/KlipProvider.tsx
  • Terminal backend: src/services/native/*, media/render-core/*
  • Toolbar: media/webviews/components/terminal/TerminalButtonBar.tsx, button library stores

Doc outputs:

  • Describe layout persistence and cell behavior.
  • Explain toolbar button types and workspace scoping.

Phase 8: Agent Configuration and Custom Commands​

Features:

  • Agent settings editor (Claude/Codex/Gemini)
  • Claude custom commands directory
  • MCP server configuration visibility

Review instructions:

  • Agent settings service: src/services/agentSettingsService.ts
  • Agents UI: media/webviews/dashboard/tabs/AgentsTab.tsx
  • MCP configs: src/services/mcpService.ts, src/views/mcp/*

Doc outputs:

  • Explain config precedence for each agent.
  • Document how custom commands are discovered and edited.

Phase 9: Daemon, API, and Diagnostics​

Features:

  • Daemon lifecycle, ports, and logging
  • Health checks, status, and error recovery
  • Daemon API keys (Pro) for scripting

Review instructions:

  • Daemon manager: src/services/daemon/daemonManager.ts
  • Daemon API status: src/services/daemon/daemonClient.ts
  • Developer tab: media/webviews/components/settings/DeveloperSection.tsx

Doc outputs:

  • Explain how to restart daemon and where logs live.
  • Document daemon API keys and usage boundaries.

Phase 10: MCP Management (Extension UI)​

Features:

  • MCP management panel and presets
  • Per-workspace MCP configuration

Review instructions:

  • MCP commands and UI: src/views/mcp/*, src/commands/mcpCommands.ts
  • MCP data flow: src/services/mcpService.ts, src/services/daemon/*

Doc outputs:

  • Document how to add/edit/remove MCP servers.
  • Clarify workspace scoping and backups.

Phase 11: Analytics, Audits, and Performance​

Features:

  • Analytics tab (usage, trends)
  • Audits and session history review
  • Performance monitor

Review instructions:

  • Analytics tab: media/webviews/dashboard/tabs/AnalyticsTab.tsx
  • Audit flow: src/services/auditService.ts, src/commands/sessionCommands.ts
  • Performance monitor: src/views/performanceMonitor/*

Doc outputs:

  • Explain what data is shown and where it comes from.
  • Document any gated features and required daemon state.

Phase 12: Navigation, Quick Actions, and UI Details​

Features:

  • Sidebar quick actions configuration
  • Walkthrough content and in-app links
  • Diagnostics and status commands in UI

Review instructions:

  • Quick actions store: media/webviews/stores/quickActions.ts
  • Walkthroughs: package.json (contributes.walkthroughs), media/walkthrough/*
  • Sidebar and dashboard navigation: src/views/sidebar/*, src/views/dashboard/*

Doc outputs:

  • Document how to customize quick actions.
  • Ensure walkthrough links point to the correct docs pages.

Phase 13: Profiles and Workspace Configuration​

Features:

  • Profiles (assign/edit) and per-workspace overrides
  • Workspace configuration display

Review instructions:

  • Profile commands: src/commands/profileCommands.ts
  • Workspace config: src/commands/settingsCommands.ts, src/views/dashboard/*

Doc outputs:

  • Explain how profiles map to workspaces.
  • Document the source of truth for workspace config.

Phase 14: Feedback, About, and Support​

Features:

  • Feedback tab and feedback submission
  • About dialog content
  • Docs link from UI

Review instructions:

  • Feedback tab: media/webviews/dashboard/tabs/FeedbackTab.tsx
  • About: src/commands/settingsCommands.ts
  • Docs command wiring: src/commands/welcomeCommands.ts, package.json commands

Doc outputs:

  • Explain what feedback contains and what is sent.
  • Ensure About + Docs references are accurate and current.

Phase 15: Account, Licensing, and Privacy​

Features:

  • Account status and licensing gates
  • Privacy and data handling

Review instructions:

  • Account UI: media/webviews/dashboard/tabs/AccountTab.tsx
  • Feature gates: src/utils/featureGates.ts
  • Privacy notes: anywhere sessions or metadata are saved

Doc outputs:

  • Clarify what is local-only vs. what can call external APIs.
  • List Pro-gated features clearly.

Optional Phase: UX Polish and Gaps​

Features:

  • Missing docs screenshots or walkthroughs
  • Known UI dead-ends or confusing labels
  • Developer-only commands that are still exposed (launcher, test tools)

Review instructions:

  • Walkthrough entries: package.json (contributes.walkthroughs)
  • UI copy in media/walkthrough/*
  • Search for TODOs in docs-klipide/docs/klip-extension/*
  • Commands: package.json (klip.openSolidJSLauncher, klip.testNativeTerminal)

Doc outputs:

  • Add concise screenshot checklist for each major UI surface.
  • Align wording across docs and in-app copy.