README.md markdown
81 lines 4.7 KB
Raw
sha256:e4c529f14a0bb908c1caaaeb3f95f3623a1a82e636e7e3722ca2cd3dc9821263 security: npm audit fix pre-bridge 2026-07-29 Human 41 days ago

Documentation index

Public documentation for Knowtation (open source). Spec, API contracts, and contributor-facing guides live here.

Internal roadmaps, thinking freezes, deploy runbooks, and session handoffs live outside this public tree under a local development/ folder (gitignored + museignored). Example: development/durable-agent-auth/ for agent-auth freeze notes and ops evidence.

Public developer recipes for agents stay in AGENT-INTEGRATION.md.

Cross-repo “what’s next” lives in Scooling docs/ROADMAP.md + docs/OVERSEER-HANDOVER.md — not in a second Knowtation roadmap.

Start here

Doc Purpose
GETTING-STARTED.md Clone, config, index, search, Hub, agents
SHOWCASE-VAULT.md Demo notes (vault/showcase/) — local tree + hosted seed
SPEC.md Data formats, CLI, config — source of truth
WHITEPAPER.md Long-form thesis; § Product updates (April 2026) for prime, doctor, import expansion, Hub bulk, docs hygiene
HUB-API.md Hub REST API (self-hosted and canister-aligned)
HUB-METADATA-BULK-OPS.md Delete/rename by project slug (Node Hub + hosted gateway)
setup.md Extended setup (OAuth, transcription, etc.)
SELF-HOSTED-SETUP-CHECKLIST.md Self-hosted checklist

Architecture and agents

Doc Purpose
AGENT-INTEGRATION.md CLI, MCP, Cursor — integrating agents
POPULAR-PROMPTS-AND-STARTERS.md MCP prompt names, copy-paste starters, CLI one-liners — Hub How to use links here
AGENT-ORCHESTRATION.md MCP + orchestration patterns
ECOSYSTEM-VISION.md Knowtation × Muse × MuseHub × AgentCeption × Stori — unified vision
MUSE-THIN-BRIDGE.md Optional Muse linkage (env, approve external_ref, admin read-only proxy)
RETRIEVAL-AND-CLI-REFERENCE.md CLI reference and retrieval tips
TOKEN-SAVINGS.md Token discipline, consolidation, hosted billing hooks
IMPORT-SOURCES.md All 17 source_type importers, Hub in-browser ZIP + multi-file (see also IMPORT-URL-AND-DOCUMENTS-PHASES)
IMPORT-URL-AND-DOCUMENTS-PHASES.md URL, PDF, DOCX, and Hub bulk (4A–4B) — roadmap, shipped status, testing, merge notes
PROPOSAL-LIFECYCLE.md Hub proposals: states, review, approve/discard
TWO-PATHS-HOSTED-AND-SELF-HOSTED.md Cloud vs self-host

Hosted / operators (high level)

Doc Purpose
MULTI-VAULT-AND-SCOPED-ACCESS.md Multi-vault (self-hosted + hosted)
PARITY-MATRIX-HOSTED.md Hosted vs self-hosted capability matrix
OPERATOR-BACKUP.md Operator backup notes
CONNECT-GITHUB-AND-STORAGE-CHECK.md GitHub connect + storage checks

Gateway and canister deploy details: hub/gateway/README.md, hub/icp/ Motoko sources and dfx workflow.

Memory, imports, evals

Doc Purpose
MEMORY-AUGMENTATION-PLAN.md Memory architecture and rollout
MEMORY-CONSOLIDATION-GUIDE.md Consolidation daemon
IMPORT-NORMALIZE-PIPELINE.md Import normalization
IMPORT-EVALS.md Import evaluations
IMPORT-MANUAL-CHECKLIST.md Manual import checks
DAEMON-CONSOLIDATION-SPEC.md Daemon consolidation spec

Manual checks (local developers)

Doc Purpose
INDEX-SEARCH-VERIFY.md CLI index/search, stores, Hub search UX notes
LOCAL-DEV-TEST-GUIDE.md Local dev smoke checks

Other

Doc Purpose
openapi.yaml OpenAPI sketch for Hub API
CLI-JSON-SCHEMA.md CLI JSON shapes
HUB-PROPOSAL-LLM-FEATURES.md Proposal review hints vs Enrich (LLM)
AI-ASSISTED-SETUP.md AI-assisted onboarding prompts

Additional topical docs in this folder (security, AIR, blockchain frontmatter, templates, etc.) are listed alphabetically in the repo file tree.

File History 6 commits
sha256:e4c529f14a0bb908c1caaaeb3f95f3623a1a82e636e7e3722ca2cd3dc9821263 security: npm audit fix pre-bridge 2026-07-29 Human 41 days ago
sha256:b5f647cb9c409f563d4671fe3fc05ddea01fabfed9b41fc11cb923588e1c1baf mirror: GitHub Phase A durable MCP OAuth (#270) Human minor 57 days ago
sha256:873e30b7fafe601346295f8f4289f388f21d8f715f28584d5481899ba2b714fc Merge pull request #249 from aaronrene/muse-mirror Agent 74 days ago
sha256:d8c648b20a4d53b2673c5c082ee7edfa7b2fc9b11080832da1f38807b6bf940b fix(7C-L1b): route hosted delegation proposals through cani… Human minor 77 days ago
sha256:2827ba9e7632a4b141c50caf1e8f7d77abbc3515be20e7465f2bccb0ac4edf91 fix: repair endpoint now sets has_active_subscription when … Human minor 97 days ago