Skip to content

Update some outdated docs + VS Code insists on adding these settings#86

Merged
daaain merged 1 commit intomainfrom
chore/docs-update
Jan 27, 2026
Merged

Update some outdated docs + VS Code insists on adding these settings#86
daaain merged 1 commit intomainfrom
chore/docs-update

Conversation

@daaain
Copy link
Owner

@daaain daaain commented Jan 26, 2026

Had some of these lying around and then I also got Claude to check other docs to sweep up some outdated stuff to not confuse people.

Summary by CodeRabbit

  • Documentation

    • Updated caching system documentation to reflect current storage implementation
    • Revised archived sessions restoration workflow with streamlined process and inline session viewing option
  • Chores

    • Updated VS Code Python interpreter configuration

✏️ Tip: You can customize this high-level summary in your review settings.

@daaain daaain requested a review from cboos January 26, 2026 22:47
@coderabbitai
Copy link

coderabbitai bot commented Jan 26, 2026

📝 Walkthrough

Walkthrough

Updates documentation and configuration for SQLite-based caching system migration. Replaces cache storage from JSON files to SQLite database at a centralized location (claude-code-log-cache.db). Updates VSCode Python settings and revises archived sessions restoration workflow documentation.

Changes

Cohort / File(s) Summary
Configuration
.vscode/settings.json
Added Python interpreter path, environment manager (venv), and pythonProjects list to configure VSCode Python environment
Documentation – Cache & Contributing
CONTRIBUTING.md
Updated cache description from generic to SQLite-based system; changed cache location to centralized claude-code-log-cache.db; added CLAUDE_CODE_LOG_CACHE_PATH environment variable reference; updated cache invalidation semantics to reference schema version
Documentation – Changelog
README.md
Removed changelog bullet about JSON-to-SQLite cache migration
Documentation – Archived Sessions
dev-docs/restoring-archived-sessions.md
Updated cache database name references (cache.db → claude-code-log-cache.db); expanded archival conditions section; revised TUI presentation to show current and archived sessions inline with [ARCHIVED] prefix; updated restore workflow to remove view-switching requirement; revised restoration instructions and added embedded view option for Markdown

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 Hoppy hops through cache so bright,
SQLite shines with all its might,
Settings sorted, docs renewed,
Archived sessions smoothly viewed!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title addresses two distinct aspects of the PR: documentation updates and VSCode settings configuration, both of which are present in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@dev-docs/restoring-archived-sessions.md`:
- Line 60: The TUI mockup footer string "[a] Archive  [r] Restore  [h] HTML  [v]
View  [c] Resume  [q] Quit" is missing the documented "[m]" key; update that
footer to include the Markdown key (e.g. add "[m] Markdown" or "[m] MD" between
"[h] HTML" and "[v] View") so it matches the documented view options described
for 'h', 'm', and 'v' on lines referencing the separate view modes.

abc123[ARCHIVED] Fix authentication bug │ 12-0145
def456[ARCHIVED] Add user settings page │ 11-28123
└──────────┴──────────────────────────────────────────────────────┘
[a] Archive [r] Restore [h] HTML [v] View [c] Resume [q] Quit
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Minor inconsistency in TUI footer keybindings.

The footer shows [v] View but doesn't include [m] for Markdown. However, Lines 79-81 document three separate view options: h (HTML), m (Markdown in browser), and v (embedded Markdown viewer). Consider updating the mockup footer to include all documented keys for consistency.

🤖 Prompt for AI Agents
In `@dev-docs/restoring-archived-sessions.md` at line 60, The TUI mockup footer
string "[a] Archive  [r] Restore  [h] HTML  [v] View  [c] Resume  [q] Quit" is
missing the documented "[m]" key; update that footer to include the Markdown key
(e.g. add "[m] Markdown" or "[m] MD" between "[h] HTML" and "[v] View") so it
matches the documented view options described for 'h', 'm', and 'v' on lines
referencing the separate view modes.

@daaain daaain merged commit 7403ae6 into main Jan 27, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants