104 lines
3.0 KiB
Markdown
104 lines
3.0 KiB
Markdown
# Summary
|
|
|
|
[Introduction](README.md)
|
|
|
|
# Project Definition
|
|
|
|
- [What is KOGRAL?](kogral/what-is-kogral.md)
|
|
- [Core Concepts](kogral/core-concepts.md)
|
|
- [Why KOGRAL?](kogral/why-kogral.md)
|
|
- [Design Philosophy](kogral/design-philosophy.md)
|
|
|
|
# Guides
|
|
|
|
- [Installation](guides/installation.md)
|
|
- [Quick Start](guides/quickstart.md)
|
|
- [Daily Workflows](guides/daily-workflows.md)
|
|
- [Use Cases](guides/use-cases.md)
|
|
- [Best Practices](guides/best-practices.md)
|
|
|
|
# Architecture
|
|
|
|
- [System Overview](architecture/overview.md)
|
|
- [Graph Model](architecture/graph-model.md)
|
|
- [Config-Driven Design](architecture/config-driven.md)
|
|
- [Storage Architecture](architecture/storage-architecture.md)
|
|
- [Logseq Blocks Design](architecture/logseq-blocks-design.md)
|
|
|
|
## ADRs
|
|
|
|
- [ADR-001: Nickel vs TOML for Configuration](architecture/adrs/001-nickel-vs-toml.md)
|
|
- [ADR-002: FastEmbed via AI Providers](architecture/adrs/002-fastembed-ai-providers.md)
|
|
- [ADR-003: Hybrid Storage Strategy](architecture/adrs/003-hybrid-storage.md)
|
|
- [ADR-004: Logseq Blocks Support](architecture/adrs/004-logseq-blocks-support.md)
|
|
- [ADR-005: MCP Protocol for AI Integration](architecture/adrs/005-mcp-protocol.md)
|
|
|
|
# Setup
|
|
|
|
- [Prerequisites](setup/prerequisites.md)
|
|
- [Installation Methods](setup/installation.md)
|
|
- [Project Initialization](setup/project-init.md)
|
|
- [Environment Configuration](setup/environment.md)
|
|
- [Verification](setup/verification.md)
|
|
|
|
# Configuration
|
|
|
|
- [Configuration Overview](config/overview.md)
|
|
- [Nickel Schemas](config/nickel-schemas.md)
|
|
- [Graph Settings](config/graph-settings.md)
|
|
- [Inheritance](config/inheritance.md)
|
|
- [Examples](config/examples.md)
|
|
|
|
# Storage
|
|
|
|
- [Storage Backends](storage/backends.md)
|
|
- [Filesystem Storage](storage/filesystem.md)
|
|
- [SurrealDB Storage](storage/surrealdb.md)
|
|
- [In-Memory Storage](storage/memory.md)
|
|
- [Sync Strategies](storage/sync.md)
|
|
|
|
# AI & Embeddings
|
|
|
|
- [Embeddings Overview](ai/embeddings-overview.md)
|
|
- [Provider Configuration](ai/providers.md)
|
|
- [FastEmbed Local](ai/fastembed.md)
|
|
- [OpenAI Integration](ai/openai.md)
|
|
- [Claude Integration](ai/claude.md)
|
|
- [Ollama Integration](ai/ollama.md)
|
|
- [Semantic Search](ai/semantic-search.md)
|
|
|
|
# Templates
|
|
|
|
- [Template System](templates/overview.md)
|
|
- [Document Templates](templates/documents.md)
|
|
- [Export Templates](templates/export.md)
|
|
- [Customization](templates/customization.md)
|
|
|
|
# CLI
|
|
|
|
- [CLI Overview](cli/overview.md)
|
|
- [Commands Reference](cli/commands.md)
|
|
- [Workflows](cli/workflows.md)
|
|
- [NuShell Scripts](cli/nushell-scripts.md)
|
|
|
|
# Apps & Connections
|
|
|
|
- [MCP Quick Guide](apps/mcp-quickguide.md)
|
|
- [Claude Code Integration](apps/claude-code.md)
|
|
- [Logseq Integration](apps/logseq.md)
|
|
- [Obsidian Compatibility](apps/obsidian.md)
|
|
- [Git Workflows](apps/git.md)
|
|
|
|
# API Reference
|
|
|
|
- [MCP Protocol](api/mcp-protocol.md)
|
|
- [Tools Reference](api/mcp-tools.md)
|
|
- [Resources](api/mcp-resources.md)
|
|
- [Rust API](api/rust-api.md)
|
|
|
|
# Contributing
|
|
|
|
- [Development Setup](contributing/development.md)
|
|
- [Code Standards](contributing/standards.md)
|
|
- [Testing](contributing/testing.md)
|