Skip to content

Latest commit

 

History

History
109 lines (87 loc) · 6.1 KB

INDEX.md

File metadata and controls

109 lines (87 loc) · 6.1 KB

Documentation Index

A complete map of everything under docs/. In-app, the same corpus is searchable through the phosphor_docs tool or by viewing any phosphor://docs/<path> file.

Getting Started

Doc Covers
CONFIGURATION.md Where config files live per OS, merge order, and a snippet for every config section. Start here.
CLI.md Global flags, subcommands, and per-command options for the phosphor CLI.
CORE_PHILOSOPHY.md Identity and core pillars of the project.
KEYBINDINGS.md Default TUI key bindings and how to configure custom ones.

Configuration

Doc Covers
MODELS_AND_PROVIDERS_CONFIG.md Configuring providers and models in phosphor.json.
THEMES.md Customizing the color scheme and branding via theme files.
LOGO_CUSTOMIZATION.md Logo text and FIGlet font settings.
UI_LAYOUT_CONFIG.md Landing screen and sidebar component layout.
observability/LOGGING.md Enabling and configuring the log file.
observability/OPEN_TELEMETRY.md OTel tracing and metrics across agent activity.

Tools

Doc Covers
tools/OVERVIEW.md Catalog of all built-in agent tools.
tools/edit_tools.md edit and multiedit: matching, safety, and diagnostics.
tools/SCAN_SECRETS.md Scanning files and git history for leaked credentials.
tools/SEMANTIC_SEARCH.md Embedding-based natural-language code search.
tools/WORKSPACE_SEARCH.md Zero-API full-text search over symbols and docs.
structural_search/README.md AST-based structural search with tree-sitter.
structural_search/CONFIGURATION.md Filtering which languages the tool advertises.
structural_search/LANGUAGE_NOTES.md Per-language support notes and caveats.

Context and Memory

Doc Covers
COMPACTION.md Auto-summarization of session history near capacity.
HISTORY_LIMIT.md Chat history pagination and rendering performance.
CONTEXT_CHAIN.md Context values propagated through the agent system.
SYSTEM_PROMPT.md How the modular system prompt is composed.
CODEBASE_INDEXING.md Workspace indexing for semantic and full-text search.

Memory

Doc Covers
memory/OVERVIEW.md How the memory system works: vaults, the entry model, write/read paths, Tier A/B injection, config, /memory.
memory/INTEGRITY.md The tamper seal: the HMAC key, what is signed vs. deliberately exempt, the threat model, key operations.
memory/POISONING.md The layered defenses against a poisoned memory entry reaching the system prompt.
memory/MEMORYGRAPH.md The memory graph viewer: live server, report export, host/port config, and node/edge semantics.

Extending the Agent

Doc Covers
SKILLS.md The skill system for teaching the agent workflows.
hooks/README.md Shell-script hooks fired on agent-lifecycle events.
commands/GOAL.md /goal: keeping the agent on one verifiable objective.
commands/LANGUAGES.md /languages dialog for structural search.
commands/LEARN.md /learn: turning reference material into skills.
commands/MENU.md /menu: quick access to common dialogs.
commands/NAME.md /name: view or rename the session.
commands/PIN_SESSION.md Pinning sessions against deletion and pruning.
commands/QUIT.md /quit.
commands/STATS.md /stats: token and cost usage.

Security

Doc Covers
security/CONFIGURATION.md Every security control and how to configure it.
security/WORKSPACE_HARDENING.md Filesystem confinement and the workspace threat model.
security/ENVIRONMENT_HARDENING.md Environment variable filtering in shell commands.
security/NETWORK_EGRESS_HARDENING.md The network egress firewall for fetch/search.
security/SECRETS_PROTECTION.md Defense-in-depth against secrets reaching the model.

Platform and Integration

Doc Covers
platform/ACP.md Running as an Agent Client Protocol server for editors.
platform/openai-api.md The OpenAI-compatible HTTP API.
platform/SCHEDULED_JOBS.md Unattended cron-scheduled agent runs.
SDK.md Embedding the agent in Go programs via pkg/client.
MERMAID.md The diagram rendering service.

Architecture

Doc Covers
architecture/OVERVIEW.md Module layout and the transport/backend split.
architecture/SESSIONS.md The two-tier session model backed by SQLite.

Architecture Decision Records

Design records for how and why features were built, in adr/. Highlights:

  • ADR-0006 — tree-sitter structural search.
  • ADR-0014 — FTS5 plus optional vector indexing.
  • ADR-0015 — the secret protection architecture.
  • ADR-0013 — platform extensibility and the SDK.