Skip to content

docs: make second-brain example runnable with local runtime#117

Closed
dottie-weaver wants to merge 2 commits into
mainfrom
docs/112-runnable-local-runtime
Closed

docs: make second-brain example runnable with local runtime#117
dottie-weaver wants to merge 2 commits into
mainfrom
docs/112-runnable-local-runtime

Conversation

@dottie-weaver

Copy link
Copy Markdown
Collaborator

Closes #112

What

Updates the second-brain example so a new user can understand and run it through the local runtime — without Cloudflare, daemon mode, or external services.

Changes

Example docs (README.md)

  • Added Running Locally section with setup, runtime run, and workflow transition commands
  • Added What happens walkthrough explaining the run lifecycle
  • Added What Agentic owns vs. the local runtime comparison table
  • Added What is not here yet section covering daemon, Cloudflare, sessions, and external artifact storage
  • Updated What Is In Here table to include .agentic/runtime/local/
  • Updated Why This Shape to reflect runtime ownership
  • Updated Extending It with runtime target guidance

Harness docs (AGENTS.md)

  • Added Running a Workflow section with runtime run, workflow start/done/next commands
  • Added runtime run and workflow start/done/next to the Agentic usage list
  • Updated Boundary section to include run creation and step discovery

Seed data

  • Added .agentic/tasks/01KTC500000000000000000001.json — seed research task
  • Added .agentic/artifacts/01KTC500000000000000000010/ — seed research brief (finalized)

Code changes (prior dogfood session, now committed)

  • runtime run <target> creates a workflow run and returns available next nodes
  • runtime run (no target) lists available workflows
  • CLI resolves --base-dir to absolute path for consistent path handling
  • Workflow filesystem adapter falls back from versioned to unversioned graph names
  • Root package.json includes examples/* in workspaces
  • Root .agentic/config.toml adds runtime config for local dogfood

Acceptance criteria

  • ✅ Example README includes a runnable local-runtime path
  • ✅ Docs distinguish Agentic core from the local runtime clearly
  • ✅ Docs connect back to Roadmap: second-brain example from private dogfood #100 without duplicating its roadmap
  • ✅ A future user can answer "how do I actually run this thing?" from the example docs alone

Testing

  • All 642 existing tests pass
  • Manual end-to-end: runtime run research-loop creates a run, returns node info, and workflow transitions work

…overy

- runtime run <target> creates a workflow run and returns available nodes
- runtime run (no target) lists available workflows
- CLI resolves --base-dir to absolute path for consistent path handling
- workflow filesystem adapter falls back from versioned to unversioned graph names
- Adds runtime config to root .agentic/config.toml for dogfood
- Includes workspace package setup for examples/* and test coverage

Tested end-to-end in dogfood session (closes #111).
)

- Add seed task and artifact for out-of-box experience
- Update README with Running Locally section covering runtime setup,
  workflow run commands, and Agentic-vs-runtime ownership boundaries
- Update AGENTS.md with runtime run and workflow transition commands
- Clarify what is not yet implemented (daemon, Cloudflare, sessions)
- Note .agentic/runtime/local/ in What Is In Here table

Acceptance criteria met:
✅ Example README includes a runnable local-runtime path
✅ Docs distinguish Agentic core from the local runtime clearly
✅ Docs connect back to #100 without duplicating its roadmap
✅ A future user can answer 'how do I actually run this thing?' from the
  example docs alone
@tnez

tnez commented Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Superseded by main at 3b90574. Issue #112 was closed by the pushed main commit, so this older branch no longer needs to merge.

@tnez tnez closed this Jun 16, 2026
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.

Docs: make second-brain example runnable with the local runtime

2 participants