23c5de38bf
The architecture.md entry implied memory-relations.ts contributes to
ranking ("knowledge-graph edges between memories"). The read consumer
doesn't exist yet — getRelevantMemoriesRanked uses cosine + static
score, not graph traversal. Relations are written via /sf memory
import / createMemoryRelation but never read for ranking.
Updated the description so a contributor reading this file knows the
graph-traversal pipeline is the next logical extension, not something
that currently runs.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
||
|---|---|---|
| .. | ||
| design-docs | ||
| dev | ||
| exec-plans | ||
| generated | ||
| product-specs | ||
| records | ||
| references | ||
| user-docs | ||
| zh-CN | ||
| DESIGN.md | ||
| FRONTEND.md | ||
| PLANS.md | ||
| PRODUCT_SENSE.md | ||
| QUALITY_SCORE.md | ||
| README.md | ||
| RECORDS_KEEPER.md | ||
| RELIABILITY.md | ||
| SECURITY.md | ||
| SPEC_FIRST_TDD.md | ||
SF Documentation
Welcome to the SF documentation. This covers everything from getting started to advanced configuration, autonomous-mode internals, and extending SF with the Pi SDK.
User Documentation
Guides for installing, configuring, and using SF day-to-day. Located in user-docs/.
Simplified Chinese translation: zh-CN/.
| Guide | Description |
|---|---|
| Getting Started | Installation, first run, and basic usage |
| Autonomous Mode | How autonomous execution works — the state machine, crash recovery, and steering |
| Commands Reference | All commands, keyboard shortcuts, and CLI flags |
| Remote Questions | Discord and Slack integration for headless auto-mode |
| Configuration | Preferences, model selection, git settings, and token profiles |
| Provider Setup | Step-by-step setup for OpenRouter, Ollama, LM Studio, vLLM, and all supported providers |
| Custom Models | Advanced model configuration — models.json schema, compat flags, overrides |
| Token Optimization | Token profiles, context compression, complexity routing, and adaptive learning (v2.17) |
| Dynamic Model Routing | Complexity-based model selection, cost tables, escalation, and budget pressure (v2.19) |
| Captures & Triage | Fire-and-forget thought capture during auto-mode with automated triage (v2.19) |
| Workflow Visualizer | Interactive TUI overlay for progress, dependencies, metrics, and timeline (v2.19) |
| Cost Management | Budget ceilings, cost tracking, projections, and enforcement modes |
| Git Strategy | Worktree isolation, branching model, and merge behavior |
| Parallel Orchestration | Run multiple milestones simultaneously with worker isolation and coordination |
| Working in Teams | Unique milestone IDs, .gitignore setup, and shared planning artifacts |
| Skills | Bundled skills, skill discovery, and custom skill authoring |
| Migration from v1 | Migrating .planning directories from the original SF |
| Troubleshooting | Common issues, /sf doctor (real-time visibility v2.40), /sf forensics (full debugger v2.40), and recovery procedures |
| Web Interface | Browser-based project management with sf --web (v2.41) |
| VS Code Extension | Chat participant, sidebar dashboard, and RPC integration for VS Code |
Architecture & Internals
Design documents, ADRs, and internal references. Located in dev/.
| Guide | Description |
|---|---|
| Architecture Overview | System design, extension model, state-on-disk, and dispatch pipeline |
| Native Engine | Rust N-API modules for performance-critical operations |
| ADR-001: Branchless Worktree Architecture | Decision record for the v2.14 git architecture |
| ADR-003: Pipeline Simplification | Research merged into planning, mechanical completion (v2.30) |
| ADR-004: Capability-Aware Model Routing | Extend routing from tier/cost selection to task-capability matching |
| ADR-007: Model Catalog Split | Separate model metadata from routing logic for extensibility |
| ADR-008: SF Tools over MCP | Native tools over MCP for provider parity |
| ADR-008: Implementation Plan | Implementation plan for ADR-008 |
| Context Optimization Opportunities | Analysis of context window usage and optimization strategies |
| File System Map | Complete file system reference |
| CI/CD Pipeline | Continuous integration and deployment pipeline |
| Frontier Techniques | Advanced techniques and research |
| PRD: Branchless Worktree | Product requirements for branchless worktree architecture |
| Agent Knowledge Index | Index of agent knowledge resources |
Pi SDK Documentation
Guides for the underlying Pi SDK that SF is built on. Located in dev/.
| Guide | Description |
|---|---|
| What is Pi | Core concepts — modes, agent loop, sessions, tools, providers |
| Extending Pi | Building extensions — tools, commands, UI, events, state |
| Context & Hooks | Context pipeline, hook reference, inter-extension communication |
| Pi UI / TUI | Terminal UI components, theming, keyboard input, rendering |
Research
| Guide | Description |
|---|---|
| Building Coding Agents | Research notes on agent design — decomposition, context engineering, cost/quality tradeoffs |
| Proposals | Feature proposals and workflow definitions |