Documentation Changelog
Tracks documentation restructuring and updates for the Klip Extension docs site.
2026-01-08: Major Documentation Restructure
Session: Documentation review and restructure with sub-agent validation
Summary
Complete restructuring of klip-extension documentation from function-based to surface/panel-based organization. Reduced from 31 files to 18 files with improved accuracy and consistency.
Sidebar Structure Changes
Before: Flat list of feature-based pages After: 4 categories with logical grouping
Getting Started (4 pages)
├── index.md
├── overview.md
├── installation.md
└── first-time-setup.md
Panels & Views (5 pages)
├── sidebar.md (NEW)
├── sessions-explorer.md (NEW)
├── klip-panel.md (UPDATED)
├── session-details.md (NEW)
└── mcp-panel.md (RENAMED from mcp-management.md)
Dashboard (5 pages)
├── dashboard-settings.md (NEW)
├── dashboard-agents.md (NEW)
├── dashboard-developer.md (NEW)
├── dashboard-analytics.md (NEW)
└── dashboard-account.md (NEW)
Reference (4 pages)
├── api-keys.md
├── data-locations.md (EXPANDED)
├── troubleshooting.md (EXPANDED)
└── support.md
Files Created
| File | Description |
|---|---|
sidebar.md | Workspace organization, navigation hub |
sessions-explorer.md | Comprehensive session browsing |
session-details.md | Summary display, stats, files |
dashboard-settings.md | All 10 settings sections |
dashboard-agents.md | Claude/Codex/Gemini config |
dashboard-developer.md | Logging, API keys (Pro) |
dashboard-analytics.md | Usage insights (Pro) |
dashboard-account.md | Subscription, privacy |
Files Deleted (Content Migrated)
| Deleted File | Content Moved To |
|---|---|
features.md | index.md, individual pages |
settings.md | dashboard-settings.md |
custom-actions.md | klip-panel.md (Button Library) |
file-tracking.md | data-locations.md |
session-management.md | sidebar.md, sessions-explorer.md, session-details.md |
documentation-tracking.md | Removed (internal) |
agent-configuration.md | dashboard-agents.md |
daemon.md | dashboard-developer.md |
analytics-audits.md | dashboard-analytics.md |
profiles.md | dashboard-settings.md (Tags section) |
summaries.md | session-details.md |
search-embeddings.md | sessions-explorer.md |
account-privacy.md | dashboard-account.md |
Critical Fixes Applied
| Issue | File | Fix |
|---|---|---|
| Wrong VS Code version | installation.md | 1.85 → 1.96 |
| Wrong marketplace URL | installation.md | klipide.klip → hotnsoursoup.Klip |
| Wrong daemon port | troubleshooting.md, dashboard-developer.md | 7842 → 19850 |
| Broken link | session-details.md | file-tracking.md → data-locations.md |
| Wrong auth docs | Multiple | Claude uses CLI auth, not API key |
| Wrong session paths | Multiple | ~/.claude/sessions → ~/.claude/projects |
| Wrong embedding default | sessions-explorer.md | Auto prefers OpenAI, not Gemini |
Settings Documentation Updates
Removed settings (no longer in codebase):
klip.sortBy- Always "last used"klip.sessionClickAction- Always "open details"klip.detailPanelPosition- Details always opens in editor
Added sections to dashboard-settings.md:
- Tags (Pro) - Env vars and init scripts
- MCP Gateway (Pro) - Server routing
Marked as planned (not yet wired):
- Terminal Appearance settings (theme, font, cursor)
Pro Features List (Standardized)
Consistent across overview.md, dashboard-account.md:
| Feature | Description |
|---|---|
| Advanced Analytics | Usage insights and trends |
| Session History Viewer | Browse full transcripts |
| Tags | Env vars and init scripts |
| Button Library | Custom terminal toolbar buttons |
| Daemon API Keys | REST API access |
| MCP Gateway | Advanced MCP server routing |
Button Library Audit Findings
Audited via sub-agent. Key findings:
- Status: 50% complete
- Working: Browse, assign, execute, reorder (up/down), visibility toggle
- Missing: Create/edit UI (API only), drag-drop reorder, grid/palette types
- Pro gating: Fully implemented (frontend + backend)
Documented in klip-panel.md with accurate capabilities and limitations.
Disabled Features Documented
| Feature | Status | Notes |
|---|---|---|
| Fork | Disabled | Pending redesign |
| Chain | Disabled | Pending redesign |
| Terminal Appearance | Planned | Settings exist but not wired to renderers |
Sub-Agent Review (3 agents)
- Getting Started + Reference - Found VS Code version, marketplace URL issues
- Panels & Views - Found broken file-tracking.md link
- Dashboard - Found missing Tags, Developer sections; port issues
All critical issues resolved.
Files Modified (Summary)
| File | Changes |
|---|---|
sidebars.ts | New 4-category structure |
index.md | Updated navigation |
overview.md | Added architecture, Pro features table |
installation.md | VS Code version, marketplace URL, Windows uninstall |
first-time-setup.md | Expanded CLI setup, cross-env sessions |
klip-panel.md | Button Library docs, terminal appearance planned |
data-locations.md | Merged file-tracking content |
troubleshooting.md | Expanded to 11 sections, fixed port |
dashboard-developer.md | Fixed API endpoint port |
session-details.md | Fixed broken link |
dashboard-settings.md | Added Tags, MCP Gateway sections |
dashboard-account.md | Updated Pro features list |
Verification Checklist
- All 18 files exist and match sidebar
- All internal links resolve
- Pro features consistently documented
- Removed settings not referenced
- Daemon port correct (19850)
- VS Code version correct (1.96)
- Marketplace URL correct (hotnsoursoup.Klip)
- Session paths correct (~/.claude/projects/)
How to Use This Document
- Before making doc changes: Check if the area was recently updated
- After code changes: Update corresponding docs and add entry here
- Git correlation: Match entries to commits by date
- Review sessions: Reference this to understand what was changed and why
Future Work
- Add screenshots to panel pages
- Expand workflow examples
- Add keyboard shortcuts documentation
- Wire terminal appearance settings (code change, then update docs)
- Button Library create/edit UI (code change, then update docs)