Documentation Index

November 8, 2025 · View on GitHub

Complete guide to all documentation in the Logseq Template Graph project.

📁 All documentation is now organized in the docs/ folder!

Start Here: Documentation Portal | README | Quick Start

For Users

Project Overview - What this project does
Quick Start Guide - Import templates (5 minutes)

For Developers

Developer Setup - Environment setup
CI/CD Pipeline - Automated workflows
Technical Reference - Deep dive

For Large Templates (15K+ lines)

Modular Quickstart - 5-minute guide
Modularization Strategy - Complete plan

📖 All Documentation

Root Level (Quick Access)

File	Audience	Description
README.md	Everyone	Project overview, features, quick start
QUICK_START.md	Users & Developers	5-minute installation and setup guide
docs/README.md	Everyone	📚 Documentation Portal

User Guides (`docs/user-guide/`)

File	Description
ui-export-guide.md	Export EDN via UI, keyboard shortcuts, partial export strategies

Developer Guides (`docs/developer-guide/`)

File	Description
ci-cd-pipeline.md	Complete CI/CD workflow, automation, git integration
conventional-commits-guide.md	Automated changelog generation and semantic versioning
conventional-commits-integration.md	Integration details, setup, and troubleshooting
modularization-review.md	GitHub Actions implementation and testing plans
implementation-summary.md	Overview of what was built

Modular Development (`docs/modular/`)

File	Description
quickstart.md	5-minute modular workflow guide
strategy.md	Complete modularization plan with split/build scripts
architecture-report.md	Complete modular architecture status and roadmap

Architecture (`docs/architecture/`)

File	Description
technical-reference.md	EDN format, class hierarchy, Schema.org mapping, best practices

Research (`docs/research/`)

File	Description
comprehensive-analysis.md	Deep dive: Logseq DB, Tana, Schema.org (10 sections, ultra-comprehensive)

🎯 Find Documentation By Task

I want to...

Task	Documentation
Use the templates	Quick Start - Users
Install Logseq DB	Quick Start - Step 0
Set up development	Quick Start - Developers
Export templates (CLI)	CI/CD Pipeline
Export templates (UI)	UI Export Guide
Work with huge templates	Modular Quickstart
Understand architecture	Technical Reference
Learn about Logseq DB/Tana	Comprehensive Analysis
Add new classes	CI/CD Pipeline + Technical Reference

📊 Documentation Stats

Total Documents: 14 comprehensive guides
Total Lines: 6,000+ lines of documentation
Organization: Categorized in docs/ folder
Last Major Update: November 2025 (modular workflow and conventional commits added)

🗺️ Recommended Reading Order

Path 1: New User (5 minutes)

README → Quick Start → Start using templates!

Path 2: New Developer (30 minutes)

README → Quick Start (Dev) → CI/CD Pipeline → Technical Reference

Path 3: Modular Development (20 minutes)

CI/CD Pipeline (Modular section) → Modular Quickstart → Modularization Strategy

Path 4: Deep Understanding (2+ hours)

Comprehensive Analysis → Technical Reference → Modularization Strategy → CI/CD Pipeline

📁 Complete File Structure

logseq-template-graph/
├── README.md                              ← Start here
├── QUICK_START.md                         ← 5-minute guide
├── DOCS_INDEX.md                          ← This file
│
└── docs/                                  ← 📚 All documentation
    ├── README.md                          ← Documentation portal
    │
    ├── user-guide/                        ← For template users
    │   └── ui-export-guide.md             ← UI export & keyboard shortcuts
    │
    ├── developer-guide/                   ← For contributors
    │   ├── ci-cd-pipeline.md              ← Workflows & automation
    │   ├── conventional-commits-guide.md  ← Commit standards
    │   ├── conventional-commits-integration.md ← Setup & troubleshooting
    │   ├── modularization-review.md       ← GitHub Actions implementation
    │   └── implementation-summary.md      ← What was built
    │
    ├── modular/                           ← For large templates
    │   ├── quickstart.md                  ← Quick modular guide
    │   ├── strategy.md                    ← Complete plan
    │   └── architecture-report.md         ← Status & roadmap
    │
    ├── architecture/                      ← Technical deep-dives
    │   └── technical-reference.md         ← EDN format, classes
    │
    └── research/                          ← Background analysis
        └── comprehensive-analysis.md      ← Logseq/Tana/Schema.org

🔗 External Resources

Logseq

Schema.org

Tana

Tana Supertags Documentation

Tools

EDN Format Specification
Babashka - For modular workflow

🤝 Contributing to Documentation

When updating documentation:

Update DOCS_INDEX.md (this file) if adding new docs
Update docs/README.md (documentation portal)
Cross-link related sections
Keep navigation consistent
Test all links before committing

💡 Tip: Bookmark the Documentation Portal for organized navigation!

Last Updated: November 2025

Back to README | Documentation Portal