polylogue/docs at master · Sinity/polylogue · GitHub
Skip to content

Latest commit

 

History

History

Folders and files

README.md

Polylogue Docs Map

Start with Guides for a task, Reference for a surface contract, and Architecture and Internals for the substrate. The remaining tiers preserve operational, evidence, design, and historical material without presenting it as a first-read path.

Guides

Document Description
Getting Started First archive, first query, and the next documentation steps.
Installation Source checkout, Nix flake, and managed NixOS/Home Manager install paths.
Onboarding First-run source detection, configuration, daemon startup, and recovery.
Search & Query Query grammar, retrieval lanes, ranking policy, and the typed SearchEnvelope contract.
Insights Available derived views and their evidence boundaries.
Export Query-set reads and renderer formats for local export packages.
Browser Capture Local browser extension capture for ChatGPT and Claude.ai sessions.
Hooks Hook-event capture, configuration, and event catalog.
Cloud Agents Privacy and setup boundaries for cloud-agent work.
Hermes Operator Guide What Polylogue watches, imports, and cannot claim from a Hermes runtime, with fidelity and privacy evidence.
Standing Agent Manual Generated six-tool invocation, continuity, query-language, and role guidance for MCP agents.
Generate Synthetic archive generation, seed mode, and demo workflows.
Maintenance Operator guide for preview, plan, run, resume, and incident recovery.
Providers Provider-specific parsing and export-format notes.
Provider Index Concise provider guide entrypoint.
ChatGPT Provider ChatGPT export detection and parser notes.
Claude.ai Provider Claude web export detection and parser notes.
Claude Code Provider Claude Code session detection and parser notes.
Gemini Provider Gemini/Drive acquisition and parser notes.
Codex Provider Codex session detection and parser notes.

Reference

Document Description
CLI Reference Generated command reference from live help output.
MCP Reference MCP tools, capability opt-ins, and client setup.
Library API Async archive API, filters, and query patterns.
Session Orchestration Evidence Stored session topology, executor observations, usage, and provenance gaps through the API and MCP.
Agent Integration Reference Generated typed contract, recipes, client delivery, and cutover reconciliation reference.
Configuration XDG paths, environment variables, and runtime configuration.
Glossary Plain-language translation of the internal taxonomy.
Provider, Origin, and Source Identity Vocabulary map for provider-wire family, public origin, material source, and parser binding.
SQLite Connection and WAL Policy Named timeout classes, checkpoint ownership and escalation, read-frame lifetime, and the connection inventory.
Provider Package Completeness Readiness report for provider/importer package modes by origin and capture mode.
Material Protocol v1 Normalized-session interchange wire format.
Sidecars Every sidecar kind, its handling contract, and the failure mode when mishandled.
Schema Annotations Versioned annotation schemas and batch provenance.
Query Identity Canonical query, query-run, and result-set reference identities.
CLI Output Schemas Machine-readable CLI output schema catalog.
Projection Render Specification Projection and renderer contract for archive reads.
Web Route Readiness States Readiness-state semantics for web routes.

Architecture and Internals

Document Description
Architecture System rings, ownership boundaries, and data flow.
Code Navigation Change-oriented map from common tasks to owning packages, entrypoints, and verification.
Architecture Spine Target shape, guardrails, and major decisions with rejected alternatives.
Architecture Hotspots Execution control center hotspot map and decomposition sequence (polylogue-1r9c).
Data Model Archive entities, storage shape, and metadata rules.
Schema Index and durable tier schema, FTS, vectors, and versioning.
Internals Working implementation reference and debugging landmarks.
Atlas: Storage Agent-orientation sheet: six-tier substrate, blob store, identity model, anchored invariants.
Atlas: Core Cold-start orientation for Polylogue's data flow, boundaries, and area sheets.
Atlas: Daemon Agent-orientation sheet: runtime ownership, convergence stages, current operational state.
Atlas: Sources and Parsers Agent-orientation sheet: acquisition, detection, normalization, and parser invariants.
Atlas: Query and Read Path Agent-orientation sheet: query planning, stable reads, and surface ownership.
Atlas: MCP Agent-orientation sheet: tool dispatch, declarations, contract flow.
Daemon Daemon ownership, convergence, HTTP serving, and service operation.
Structured Logging Event vocabulary, correlation context, outcome honesty, the field allowlist, and the conversion recipe.
Daemon Threat Model Local API assets, threats, mitigations, and roles.
Security Security boundaries for local archives and readers.
Archive Backup Archive-tier backup profiles, restore boundaries, and blob-GC safety rules.
Cost Model Cost, usage, cache, and subscription-credit accounting semantics.
Agent Forensics Forensic investigation methods over agent work.
Repository Layout Every top-level entry and its purpose.

Operations and Contributor Workflow

Document Description
Developer Tools Generated surfaces, validation, and repo hygiene.
Artifact Publication Filesystem contract shared by the cache and reusable-fixture publication routes.
Verification Authority Sole ownership matrix for AgentCTL execution and Polylogue semantic verification.
AgentCTL Development-Loop Proof Declared browser-capture proof with AgentCTL-owned host lifecycle.
Visual Evidence Synthetic reader DOM/media evidence lanes and local screenshot boundaries.
Release Checklist Cut-time packaging, installed-artifact, and publish checks.

Demos, Evidence, and Product

Document Description
Demos and Proofs Reproducible proofs, construct-valid demo doctrine, and flagship demonstrations.
Full-Archive Dogfooding Versioned question queue, cycle packet, comparison method, and priority review rules.
Structured Failure Follow-Up Bounded finding with a structural oracle, sample frame, calibration, and caveats.
Corpus Reliability and Closure Reliability Measured distinction between stale assertions, void records, and closure reliability.
Polylogue on Sinex Current bridge, target authority split, and rebuild proof.
Insights Rigor Matrix Evidence strengths and limitations for insight families.
Query-Action Workflows Selection rules, common paths, and executable demo-archive evidence.
Reader-Comprehension Test Harness Single-blind N-arm cold-reader test harness for README/positioning candidates.
Example and Proof Index Index of recorded proof artifacts and worked examples.

Design Notes

Document Description
Design Direction Design doctrine and standing domain-model references.
Agent-First MCP Agent-facing MCP surface doctrine.
Archive Storytelling Narrative and artifact design for archives.
Hermes Archival Export Contract Versioned Hermes session export schema, durable lifecycle-event spool, and snapshot reconciliation.
Project Memory Long-term memory model and product intent.
Query Set Algebra Set-composition semantics over query results.
Session Lineage Model Fork, resume, compaction, and composition semantics.
Analysis Rigor Rigor mechanisms for agent claims: population validity and comparative judgment.
Prefix-Blob Reclamation Reference-blob representation for byte-proven superseded revision prefixes.
Derived-artifact freshness Source-digest and verify-or-refuse law for derived state.
Convergence Simplification Inventory Deletion/collapse inventory for the daemon convergence redesign (polylogue-m6tp).
Workload Artifact Consolidation Ledger Census and per-candidate disposition for duplicate workload and corpus artifact builders under tests/infra.
Typed WebUI Capability Matrix Cutover inventory for typed and legacy browser capabilities.
Second Brain Vision note for remembered work.
Time Machine Vision note for reconstructing work over time.
Whole Product Product vision and system relationships.

Historical Records and Generated Artifacts

Document Description
1498 Cascade Retrospective Historical cascade incident retrospective.
Retrospective Index Index of historical incident retrospectives.

Contributor Workflow

Document Description
Contributing Branching, issues, PRs, squash-merge history, and repo policy.
Testing Baseline test matrix, protected surfaces, and verification entrypoints.
Agent Guide Agent memory and working rules.
Security Policy Trust-boundary summary, supported versions, and vulnerability reporting contact.