mirror of
https://github.com/fabro-sh/fabro.git
synced 2026-10-07 03:00:29 +00:00
283eab181f
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.
24 lines
1.3 KiB
Markdown
24 lines
1.3 KiB
Markdown
# Fabro Technical Requirements
|
|
|
|
This note captures stable constraints that product changes should respect.
|
|
|
|
## Core constraints
|
|
|
|
- Fabro ships primarily as a single Rust binary with CLI and server modes.
|
|
- Workflows are defined in Graphviz DOT and should remain reviewable as source files.
|
|
- The workflow engine must support loops, branching, parallel stages, commands, agent stages, and human gates.
|
|
- Model routing is per-stage and provider-agnostic through stylesheets and config.
|
|
- Execution happens through sandbox providers rather than assuming direct host access.
|
|
- Git checkpointing is central to resume, rewind, fork, and auditability.
|
|
- Runs produce structured artifacts such as `progress.jsonl`, `live.json`, `checkpoint.json`, and optional `retro.json`.
|
|
- The HTTP API is OpenAPI-based, and the web app depends on that contract.
|
|
|
|
## Operational constraints
|
|
|
|
- Documented targets are macOS arm64, Linux x86_64, and Linux arm64.
|
|
- Git is required for checkpointing-related workflows.
|
|
- Docker, Graphviz, and SSH are optional system dependencies depending on the features in use.
|
|
|
|
## Design bias
|
|
|
|
Prefer changes that improve determinism, observability, resumability, and safe unattended execution. Avoid features that only make sense as IDE autocomplete or a chat-first REPL.
|