Commit graph

19 commits

Author SHA1 Message Date
Himanshu Dongre
c0ca5d1998 Refresh README and docs for the current product surfaces
A focused truth + packaging pass before the website sprint — the product
moved a lot since the last docs sync (local-first SQLite, quickstart,
doctor, attached-repo no-arg workflow, repo-state drift detection,
deletion safety).

README: refresh the stale "Built with Smriti" metrics to current numbers;
add repo-state drift detection and destructive-action guards to the
coordination/trust surfaces; add an explicit no-arg daily-workflow block
so the new-user path (setup -> doctor -> quickstart -> attach -> no-arg
state/current/metrics) routes cleanly.

ARCHITECTURE: correct the /health capabilities list (add
activation_health); document repo-state drift detection.

DECISIONS: record why drift detection is CLI-side and why destructive
Space deletion is gated, not prevented.

REPO_STRUCTURE / CONTRIBUTING: correct the CLI command list (add attach,
quickstart; 16 commands) and the skill-pack template version (2.4).

cli/README.md was already current and is unchanged. The agent skill pack
still teaches manual reconciliation and is deliberately left for its own
versioned follow-up pass.
2026-05-19 23:51:02 +05:30
Himanshu Dongre
727990d899 Require MCP confirmation for space deletion 2026-05-19 01:12:49 +05:30
Himanshu Dongre
f4062da76e Sync docs and regenerate skill pack for the current product surface
Packaging/readiness pass — documentation only, no feature or behavior change.

- REPO_STRUCTURE.md, CONTRIBUTING.md: corrected test counts (156 integration,
  133 unit, 151 CLI), local-first setup flow (make setup-local / dev-local),
  command count, new routes/types/test files.
- README.md: refreshed dogfood metrics, added Project Current State and
  smriti doctor to the surfaces, SQLite to the tech stack.
- cli/README.md: MCP tool count 17 -> 21 (added the four worktree tools),
  documented the smriti worktree commands.
- ARCHITECTURE.md: API table now lists the Project Current State and metrics
  endpoints; new Database modes section (local SQLite / Postgres).
- DECISIONS.md: recorded the local-first SQLite mode and Project Current
  State surface decisions.
- AGENTS.md: regenerated from skill pack template v2.3 (was a stale v1.5
  render); the .claude/ claude-code render was likewise refreshed locally.

.env.example, docs/DEMO_SCRIPT.md, and CLAUDE.md were reviewed and left as-is.
2026-05-17 00:03:59 +05:30
Himanshu Dongre
c470947477
Polish worktree short ids and clean finish (#5) 2026-05-04 15:28:19 +05:30
Himanshu Dongre
8c963198e1 Add canonical project root for spaces 2026-05-04 13:43:44 +05:30
Himanshu Dongre
3cb514b279 Add V3 dirty paths and skill pack v2.1 2026-05-04 13:11:20 +05:30
Himanshu Dongre
c4a21f3d7d Sync CONTRIBUTING test counts; expand DECISIONS worktree rationale
CONTRIBUTING: fix stale test counts (177 integration / 97 unit / 70 CLI
became 122 / 125 / 122 across V1+V2 work).

DECISIONS: expand the V2 worktree rationale section. The V2 PR shipped
a single paragraph on "why binding is optional"; this adds the broader
design rationale that motivates the primitive itself — the chaanbeen
catastrophic failure mode, why git worktrees vs separate clones, why
state-brief shells out to git per request rather than persisting drift,
why the probe cache is 60s. Existing "binding is optional" paragraph
stays, now flowing naturally from the expanded context.

Done in worktree ~/.smriti/worktrees/smriti-dev/claude-code-555d3005
on branch smriti/claude-code/555d3005 in parallel with Codex's
worktree-list-probe work (V2 dogfood test).
2026-05-04 12:51:16 +05:30
Himanshu Dongre
39003a8aa6 Add V2 worktree-bound claims 2026-05-04 12:16:32 +05:30
Himanshu Dongre
fad732d7e9 Integrate Codex's intent-vocabulary rationale into DECISIONS.md
Cherry-picked the non-redundant section from Codex's
codex/docs-task-claim-affinity-rationale branch: "Why structured
tasks reuse the claim intent vocabulary." Dropped Codex's
open/done-status section (redundant with existing coverage).

The three structured-task decision sections now flow as:
  reuse vocabulary → instead of task manager → open/done only
2026-04-13 23:25:02 +05:30
Himanshu Dongre
56526a1d78 Document structured tasks and task-claim affinity design rationale
ARCHITECTURE.md: new section on structured tasks as the autonomy
mechanism — task shape, intent hints, status semantics, extract
prompt, rendering, and the selection logic.

DECISIONS.md: why structured tasks instead of a task manager, a
recommended-action endpoint, or richer claim semantics. Why task
status is open/done only — claims are live state, tasks are durable.
2026-04-13 23:14:41 +05:30
Himanshu Dongre
ae94d73ad3 Skill pack v1.6: teach checkpoint notes, fix stale tool count (16→17) 2026-04-13 20:52:49 +05:30
Himanshu Dongre
4ddd0e2ef7 Sync docs: 15->16 MCP tools, add init+branch to REPO_STRUCTURE, add smriti_close_branch to tools table 2026-04-13 14:41:41 +05:30
Himanshu Dongre
2f98a31323 Fix stale MCP tool counts: 13->15 across all docs 2026-04-13 11:09:17 +05:30
Himanshu Dongre
757e3c21e3 Synchronize docs with current shipped state: work claims, runtime model, testing guidance 2026-04-13 01:13:00 +05:30
Himanshu Dongre
299382b6bf Document skill pack and multi-branch state as the V4 surfaces
cli/README.md:
- Add an "Installing the Smriti skill pack" subsection between the MCP
  server section and the Commands reference. Walks through the target
  list (claude-code, codex), the CLI install flow, the MCP-tool flow
  (read the returned markdown, write via host file tools), and the
  verification criterion ("agent calls state unprompted, never writes
  HANDOFF.md").
- Update the MCP tools table to 13 entries (add smriti_install_skill).
- Update the Commands reference to include smriti skills list/show/
  install and the new --main-only flag on smriti state.
- Update the "Using Smriti from a coding agent" walkthrough to note
  multi-branch state as the default, with caps and the --main-only
  escape hatch.

README.md (root):
- Expand the agent-facing surfaces section to list four surfaces, not
  three: chat UI, CLI, MCP server, agent skill pack. Explain what the
  skill pack does in one paragraph.
- Update the "Where this is going" outlook to acknowledge that the
  transport gap is closed, the fluency gap is what the skill pack
  addresses, and the open questions are now shape questions.

DECISIONS.md:
- Add "Why skill packs are a first-class surface, not documentation" —
  records the reasoning for shipping versioned instruction files into
  agent host project directories rather than a docs site, and explains
  why Section 5 ("When NOT to checkpoint") gets equal weight to "When
  to checkpoint."
- Add "Why smriti state is multi-branch by default" — records why the
  default was flipped, what the hard caps are, that divergence
  detection reuses the compare normalization, and that --main-only /
  main_only=True preserves the legacy path for scripts.

ARCHITECTURE.md:
- Split the agent-facing backend section into runtime surfaces (CLI,
  MCP, chat UI) and the onboarding surface (skill pack) to make the
  distinction between how agents call Smriti and how they learn to
  call Smriti explicit.
- Expand the CLI + MCP surface descriptions to reference the new V4
  state endpoint and the new smriti_install_skill MCP tool (13 tools
  now).
- Add a "Multi-branch state" subsection documenting the new endpoint,
  the hard caps, the reuse of _diff_lists from lineage, and the
  backward-compat story via --main-only / main_only=True.
- Update the API versioning table to note /api/v4/chat/spaces/{id}/state
  as the agent-facing default alongside /head.
2026-04-12 02:14:35 +05:30
Himanshu Dongre
e8711ee48c Update docs to reflect CLI + MCP transport parity
Five rounds of dogfood testing closed the basic agent handoff loop and MCP
shipped as the second transport. Update the docs to match:

- cli/README.md: replace the brief "Typical agent workflow" + "Multi-branch
  workflow" sections with a transport-agnostic "Using Smriti from a coding
  agent" walkthrough. CLI commands and their MCP tool equivalents are shown
  side by side. Covers orient → work → checkpoint → hand off, the extractor
  path (no hand-written JSON anymore), and the branching/compare/restore
  flow.
- README.md (root): list MCP as a third surface alongside the chat UI and
  CLI. Update the "Where this is going" outlook to acknowledge that the
  handoff loop is proven and the open questions are now shape questions,
  not transport questions.
- ARCHITECTURE.md: add MCP server as a third entry in the agent-facing
  backend section, with the deliberate differences from the CLI (no cwd
  auto-capture, no per-tool confirmation) spelled out.
- DECISIONS.md: keep the original "why CLI first, not MCP" entry as
  historical context and add a "Shipping MCP as the second transport"
  entry recording the design decisions made at ship time (same package,
  FastMCP, stdio only, 12 tools, extract-only create_checkpoint, empty
  project_root default, MagicMock unit tests).
2026-04-12 01:14:49 +05:30
Himanshu Dongre
89b6df16cf Add CLI for agent and programmatic access
Introduce a thin Python CLI that wraps the backend REST API. Seven
commands: space list, space create, state, checkpoint create,
checkpoint show, checkpoint list, checkpoint review. Reads piped
JSON on stdin for checkpoint create, prints a continuation-oriented
markdown brief for state. Supports --json on every command for
structured output.

Fixes a V2 schema drift where the commit response omitted
assumptions and artifacts, so the CLI can read full checkpoints
via the cleaner V2 single-resource endpoints. Updates README,
ARCHITECTURE, and DECISIONS to frame Smriti as a reasoning-state
backend with the chat UI and CLI as two clients of the same core.
2026-04-11 11:10:01 +05:30
Himanshu Dongre
744b3ee745 Align docs with current product capabilities
Update README with restore UX, checkpoint review, assumptions,
and artifacts. Add when-to-use guidance. Sharpen problem statement
around drift and recovery. Update ARCHITECTURE with new checkpoint
fields and restore terminology. Add three new decisions to
DECISIONS.md. Document review endpoint and new fields in API docs.
2026-04-04 22:02:58 +05:30
Himanshu Dongre
befea97bf6 Initial public release 2026-03-22 13:48:50 +05:30