Skip to content

Docs: sweep for accuracy after 0.18 - #18

Merged
sdeken merged 1 commit into
mainfrom
claude/electron-devlog-git-fai4tv
Sep 29, 2026
Merged

sdeken merged 1 commit into
mainfrom
claude/electron-devlog-git-fai4tv

Conversation

@sdeken

@sdeken sdeken commented Sep 29, 2026

Copy link
Copy Markdown
Owner

A documentation sweep after 0.18.0. Every document was checked against the code and rewritten or corrected where it had drifted. Time tracking now lives in devlog-time (the app has no Tracker), storage is format 4, blocks form a tree that opens as pages, and canvases have node types. The docs also now cover extension API 1.7, the Timesheet and Summary as extension pages, and destinations reached through the app.

Rewritten

  • docs/EXTENSIONS.md: now a reference for the model as built. It covers the manifest, the lockfile, consent/grants/trust, settings and secrets, the sandbox limits, and what an extension can do by topic, with API version tags. It ends with a list of what is not built yet.
  • docs/TIME-EXTENSION.md: describes the finished state. It has a table of what belongs to devlog-time versus the app, what each API version (1.5–1.7) added, the data layout, and hour targets.
  • docs/DESIGN.md:
    • Process model and storage layout: format 4, devlog.lock.json, extensions/<id>/, and todos.md removed.
    • Blocks as a tree and canvases with node types.
    • The time and activity-log section now describes devlog-time plus the main process's machine state. The activity log is written only while an extension provides time.
    • Also updated: review, auto-update, the editor, and sync. A short new Extensions section points to EXTENSIONS.md.

Corrected

  • docs/TIMESHEETS.md, docs/BLOCK-PAGES.md, README.md: UI names, shortcuts, the repository layout, the Summary as a page, and the release procedure.
  • packages/core/README.md, packages/extension-api/README.md: the API table now covers everything up to 1.7 and the testing section lists the harness helpers. builtin-extensions/README.md and the devlog-focus manifest description are also corrected.
  • Code comments in packages/core/src/node/manifest.ts and packages/core/src/format/canvases.ts that still said storage format 3.

Not only docs

  • package.json: package, package:mac, package:win, package:linux and screens now run npm run build instead of electron-vite build. Before, packaging from a fresh clone skipped bundling the built-in extensions. CI already ran npm run build and is unaffected.
  • The hour-targets example in docs/TIME-EXTENSION.md and tests/devlog-time.test.ts now uses a made-up client name.

Checks

  • npm run typecheck passes.
  • npx vitest run: all 231 tests pass.

🤖 Generated with Claude Code

https://claude.ai/code/session_01CAgWUf68JDhC5YPtWj1zT6


Generated by Claude Code

Rewrite or correct every document against the code as it is now: time
tracking lives in devlog-time (no Tracker in the app), storage format 4,
blocks as a tree with pages, node types, extension API 1.7, the
Timesheet and Summary as extension pages, destinations reached through
the app, quiet paths for activity/ and extensions/.

- docs/EXTENSIONS.md: restructured as a reference for the model as built.
- docs/DESIGN.md: process model, storage layout, blocks, canvases and node
  types, time and the activity log, review, auto-update, editor, sync, and
  a short Extensions section.
- docs/TIME-EXTENSION.md, TIMESHEETS.md, BLOCK-PAGES.md: status and details
  brought up to date.
- README.md, packages/*/README.md, builtin-extensions/README.md: stale UI
  names, shortcuts, file layout and API tables fixed.
- Code comments in manifest.ts and canvases.ts that still said format 3.
- package.json: package* and screens now run `npm run build`, so the
  built-in extensions are bundled when packaging from a fresh clone.
- Use a synthetic client name in the hour-targets example and test.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CAgWUf68JDhC5YPtWj1zT6
@sdeken
sdeken merged commit 92ef4bb into main Sep 29, 2026
8 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