Logo
Explore Help
Sign In
jesus/kogral
1
0
Fork 0
You've already forked kogral
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
kogral/docs/SUMMARY.md
Jesús Pérez 22e9473e69
chore: add docs
2026-01-23 16:11:07 +00:00

3.0 KiB
Raw Blame History

Summary

Introduction

Project Definition

  • What is KOGRAL?
  • Core Concepts
  • Why KOGRAL?
  • Design Philosophy

Guides

  • Installation
  • Quick Start
  • Daily Workflows
  • Use Cases
  • Best Practices

Architecture

  • System Overview
  • Graph Model
  • Config-Driven Design
  • Storage Architecture
  • Logseq Blocks Design

ADRs

  • ADR-001: Nickel vs TOML for Configuration
  • ADR-002: FastEmbed via AI Providers
  • ADR-003: Hybrid Storage Strategy
  • ADR-004: Logseq Blocks Support
  • ADR-005: MCP Protocol for AI Integration

Setup

  • Prerequisites
  • Installation Methods
  • Project Initialization
  • Environment Configuration
  • Verification

Configuration

  • Configuration Overview
  • Nickel Schemas
  • Graph Settings
  • Inheritance
  • Examples

Storage

  • Storage Backends
  • Filesystem Storage
  • SurrealDB Storage
  • In-Memory Storage
  • Sync Strategies

AI & Embeddings

  • Embeddings Overview
  • Provider Configuration
  • FastEmbed Local
  • OpenAI Integration
  • Claude Integration
  • Ollama Integration
  • Semantic Search

Templates

  • Template System
  • Document Templates
  • Export Templates
  • Customization

CLI

  • CLI Overview
  • Commands Reference
  • Workflows
  • NuShell Scripts

Apps & Connections

  • MCP Quick Guide
  • Claude Code Integration
  • Logseq Integration
  • Obsidian Compatibility
  • Git Workflows

API Reference

  • MCP Protocol
  • Tools Reference
  • Resources
  • Rust API

Contributing

  • Development Setup
  • Code Standards
  • Testing
Powered by Gitea Version: 1.23.8 Page: 14ms Template: 1ms
English
English Español
Licenses API