mirror of https://github.com/fabro-sh/fabro.git synced 2026-09-14 23:22:51 +00:00

refactor(docs): split docs/ into public/ and internal/

Invert the docs convention so the Mintlify-published site lives under
docs/public/ and internal artifacts (strategy docs, brainstorms, plans,
etc.) sit at docs/ root or docs/internal/. Tools that default to writing
into docs/ now land in the catch-all instead of leaking into the
published tree.

- Move Mintlify content (administration/, agents/, api-reference/,
  changelog/, core-concepts/, examples/, execution/, getting-started/,
  human-tools/, integrations/, languages/, reference/, tutorials/,
  workflows/, images/, logo/, docs.json, favicon.svg, dot-highlight.js)
  into docs/public/.
- Collapse docs-internal/ into docs/internal/.
- Update Rust path references (fabro-api/build.rs, fabro-server,
  fabro-dev), TypeScript generator arg, CI path filters, clippy.toml
  reasons, AGENTS.md/CLAUDE.md, and README.md image refs.

Mintlify dashboard project root must be updated to docs/public/ in a
follow-up. .mintignore move/trim and .claude/skills/ updates land in a
separate commit.

2026-04-27 07:21:13 -07:00

2.2 KiB

Raw Blame History

Run Scratch Files

This document maps the files that still live under a run scratch directory. Durable run state lives in the run store and metadata branch; scratch is mostly local runtime state and caches.

Scope:

Scratch root: ~/.fabro/scratch/YYYYMMDD-{run_id}/
This covers local run files only
Persistent store keys live in lib/crates/fabro-store/src/keys.rs
Artifact object-store keys live in lib/crates/fabro-store/src/artifact_store.rs

There is no _init.json anymore. Run existence in the database is determined by stored run events, and local scratch directories are managed separately under scratch/.

Root-Level Files

File	Purpose	Source
`workflow_bundle.json`	Bundled workflow input used by `start` to restore `workflow_path` and bundled child workflows/files	Written during create from the resolved workflow bundle
`run.pid`	Legacy detached-run pid file from older runs	Legacy only; current flows do not rely on it

Local-Only Directories

These paths are local runtime state, not canonical event projections.

Path	Purpose
`worktree/`	Git worktree used by checkpointed runs
`runtime/server.log`	Worker tracing log for the run
`runtime/blobs/`	Materialized local blob payloads for file-backed `fabro+blob://` references
`nodes/{manager_node}_{visit}/child/`	Nested scratch root for manager-loop child workflows

Reconstructed / Exported Files

These names are still real, but they are no longer live scratch files by default:

Metadata branch files such as run.json, start.json, checkpoint.json, and retro.json
fabro dump exports such as run.json, start.json, status.json, checkpoint.json, conclusion.json, retro.json, events.jsonl, and per-node prompt/response/status/stdout/stderr files
Retro-agent temp uploads named progress.jsonl, checkpoint.json, run.json, and start.json inside the retro sandbox

Notes

Artifact binaries are no longer stored in the SlateDB keyspace. They live in ArtifactStore; the run scratch tree only contains local cached copies when a workflow stage writes them to disk.
Final diffs for checkpointed runs are projected from the run store; they are no longer written as scratch files.

2.2 KiB Raw Blame History