Skip to content

README.md

Latest commit

 

History

History
46 lines (35 loc) · 2.62 KB

README.md

File metadata and controls

46 lines (35 loc) · 2.62 KB
Raw

Kosmos Docs

This folder is the main documentation hub for Kosmos. Kosmos is positioned as the local trust layer for AI working inside Obsidian-style vaults, repos, prompts, and knowledge bases.

Start Here

Guide Best for Outcome
Getting Started First-time users Open Kosmos, understand the core screens, and complete a useful first session
CLI And Install Guide Setup and launch details Learn the npx workflow, common flags, and local launch patterns
Product Positioning Product direction Understand the Obsidian-adjacent trust-layer wedge and what the product should become
Screenshots And Product Tour GitHub visitors and demos See the major surfaces and understand what each one is for

Core Product Guides

Guide Focus
Architecture Guide How scanning, runtime events, prompts, traces, and storage fit together
Live Monitoring Guide Watching runtime activity as it happens
Trace Inspector Guide Debugging a run from summary down to span-level detail
Prompt Versioning Guide Saving prompt history and comparing versions against real runs
Integrations Guide Claude Code, OpenClaw, and custom local ingest workflows

Operational Guides

Guide Focus
Troubleshooting Common setup, scanning, and runtime issues
FAQ Fast answers about privacy, storage, supported workflows, and expectations
Releasing And Publishing Preflight checks, screenshots, public repo polish, and publish flow

Recommended Reading Order

  1. Start with Getting Started.
  2. Read Product Positioning to understand the trust-layer wedge.
  3. Keep CLI And Install Guide open if you need launch options or npx examples.
  4. Use Architecture Guide to understand what Kosmos is modeling.
  5. Learn live workflows in Live Monitoring Guide.
  6. Debug real sessions with Trace Inspector Guide.
  7. Add iteration discipline with Prompt Versioning Guide.
  8. Use Troubleshooting and FAQ when something feels off.
  9. Finish with Releasing And Publishing when you are preparing a public release.

Wiki Source

If you want GitHub wiki-style navigation, the source pages live in ../wiki/Home.md.