Docs Home

Source mirrored from seocho/docs/README.md

SEOCHO docs are organized around one question: what do you need to do right now?

Start Here

If you need to…	Start here
get a first local success path	../QUICKSTART.md
understand local ask() vs runtime semantic/react/debate	../README.md#execution-surfaces
bring up the full local runtime stack	RUNTIME_DEPLOYMENT.md
follow a runnable notebook walkthrough	../examples/quickstart.ipynb
understand SEOCHO with architecture snippets	BEGINNER_GUIDE.md
use the Python SDK directly	PYTHON_INTERFACE_QUICKSTART.md
declare reusable agent patterns in YAML	AGENT_DESIGN_SPECS.md
declare graph-model-aware indexing in YAML	INDEXING_DESIGN_SPECS.md
bring your own ontology and data	APPLY_YOUR_DATA.md
inspect files, artifacts, and traces	FILES_AND_ARTIFACTS.md
understand the system design	ARCHITECTURE.md
understand the top-level repository layout	REPOSITORY_LAYOUT.md
review repository hierarchy cleanup priorities	REPOSITORY_HIERARCHY_REVIEW.md
understand GitHub automation	GITHUB_AUTOMATION.md
present SEOCHO to a technical audience	presentations/SEOCHO_OVERVIEW_DEEP_DIVE.md
measure behavior with FinDER and benchmark tracks	BENCHMARKS.md

Recommended onboarding order:

1. WHY_SEOCHO.md
2. ../QUICKSTART.md
3. ../examples/quickstart.ipynb
4. BEGINNER_GUIDE.md
5. PYTHON_INTERFACE_QUICKSTART.md
6. APPLY_YOUR_DATA.md
7. FILES_AND_ARTIFACTS.md
8. ARCHITECTURE.md
9. presentations/SEOCHO_OVERVIEW_DEEP_DIVE.md

Product Entry Points

• WHY_SEOCHO.md: product framing and ontology-aligned value proposition
• ../QUICKSTART.md: shortest local success path
• RUNTIME_DEPLOYMENT.md: full local runtime deployment guide for Docker stack, services, and environment setup
• ../examples/quickstart.ipynb: runnable notebook covering ontology, indexing design, agent design, indexing, query, .env-backed provider setup, safe Ladybug fallback, optional Neo4j/DozerDB, and provider comparison
• BEGINNER_GUIDE.md: first-run guide that connects SDK snippets to architecture seams
• PYTHON_INTERFACE_QUICKSTART.md: public Python SDK path and API examples
• AGENT_DESIGN_SPECS.md: YAML-backed agent patterns with required ontology bindings
• INDEXING_DESIGN_SPECS.md: YAML-backed indexing variants for LPG, RDF, hybrid, and inquiry-cycle defaults
• APPLY_YOUR_DATA.md: ingest your own records and query them safely
• FILES_AND_ARTIFACTS.md: where ontology files, semantic artifacts, rule profiles, and traces live
• BENCHMARKS.md: FinDER and GraphRAG benchmark tracks
• ARCHITECTURE.md: architecture deep dive and module map

Architecture And Operations

• ARCHITECTURE.md: system architecture and runtime/module map
• INTERNAL_CLASS_DESIGN.md: internal orchestration seam classes (DomainEvent, IngestionFacade, QueryProxy, AgentFactory, AgentStateMachine) used while the modular monolith is still being decomposed
• presentations/SEOCHO_OVERVIEW_DEEP_DIVE.md: 20-30 minute beginner-friendly product and architecture deck
• RUNTIME_PACKAGE_MIGRATION.md: staged extraction/ to runtime/ migration plan
• GRAPH_RAG_AGENT_HANDOFF_SPEC.md: intent-first graph answer contract
• ONTOLOGY_RUN_CONTEXT_STRATEGY.md: ontology context contract across indexing, query, and agents
• PROPERTY_GRAPH_LENS_STRATEGY.md: semantic overlay strategy for property graphs
• INTERNAL_CLASS_DESIGN.md: internal orchestration seams for the modular monolith
• MODULE_OWNERSHIP_MAP.md: canonical module ownership and compatibility boundaries
• ARCHITECTURE_HEALTH.md: per-domain quality scorecard (grade + coverage + gaps, tracked over time)
• WORKFLOW.md: operational workflow
• GITHUB_AUTOMATION.md: GitHub Actions, Codex automation, and .github/ placement rules

Contributor References

• ISSUE_TASK_SYSTEM.md: sprint and task governance
• REPOSITORY_LAYOUT.md: root directory intent, canonical edit surfaces, and legacy/local-only paths
• REPOSITORY_HIERARCHY_REVIEW.md: architecture review of repo hierarchy cleanup priorities and tradeoffs
• OPEN_SOURCE_PLAYBOOK.md: contributor onboarding
• decisions/DECISION_LOG.md: architecture decision history
• ../CONTRIBUTING.md: contribution flow and PR rules

Docs Sync Integration

• GitHub README.md is the fastest product landing page.
• docs/* is the source of truth for long-form product, operator, and system contracts.
• website/ is the tracked Astro/Starlight source for https://seocho.blog.
• website/scripts/generate-docs.mjs materializes selected /docs/* and /blog/* pages from the repo-root source docs at build time.
• Generated mirror files under website/src/content/docs/docs/ are derived artifacts; edit the repo-root source docs instead.
• Validate the site with cd website && npm ci && npm run check:docs && npm run build && bash scripts/check-built-links.sh.