Documentation Portal
November 8, 2025 · View on GitHub
Welcome to the Logseq Template Graph documentation! This comprehensive guide will help you use, customize, and contribute to the project.
Quick Navigation: User Guide | Developer Guide | Architecture | Research
📚 Documentation Structure
User Guide
For people who want to use the templates in their Logseq graphs.
| Document | Description |
|---|---|
| Installation Guide | Install Logseq DB and import templates |
| Getting Started | Quick start guide for users |
| UI Export Guide | Export via UI with keyboard shortcuts and partial exports |
Developer Guide
For people who want to contribute or customize templates.
| Document | Description |
|---|---|
| Developer Setup | Set up your development environment |
| Contributing Guide | How to contribute to the project |
| Conventional Commits Guide | Automated changelog generation and semantic versioning |
| Conventional Commits Integration | Integration details, setup, and troubleshooting |
| CI/CD Pipeline | Automated export workflow and git integration |
| Modularization Review | GitHub Actions implementation and testing plans |
| Implementation Summary | Overview of what was built and how |
Modular Development
For working with large templates (5,000+ lines, 100+ classes).
| Document | Description |
|---|---|
| Modular Quickstart | 5-minute guide to modular workflow |
| Modularization Strategy | Complete plan for splitting and building templates |
| Architecture Report | Complete modular architecture status and roadmap |
Architecture
Technical deep-dives for understanding how it works.
| Document | Description |
|---|---|
| Technical Reference | EDN format, class hierarchy, and best practices |
Research
Background information and comparative analysis.
| Document | Description |
|---|---|
| Comprehensive Analysis | Deep dive into Logseq DB, Tana, and Schema.org |
🎯 Recommended Reading Paths
Path 1: New User
- README - Understand what the project does
- Quick Start - Import templates into Logseq
- Start using! Tag pages with
#Person,#Organization, etc.
Path 2: New Developer
- README - Project overview
- Quick Start - Developer setup
- CI/CD Pipeline - Understand the workflow
- Technical Reference - Deep dive
Path 3: Modular Development
- CI/CD Pipeline - Standard workflow
- Modular Quickstart - Why and when to modularize
- Modularization Strategy - Complete implementation plan
Path 4: Deep Understanding
- Comprehensive Analysis - Background research
- Technical Reference - Architecture details
- Modularization Strategy - Advanced workflows
📖 Quick Reference
Common Tasks
I want to import templates → Quick Start - For Users
I want to contribute a new class → Developer Setup → Contributing Guide → Conventional Commits
My template is huge (15K+ lines) → Modular Quickstart
I want to understand how it works → Technical Reference
I want to learn about Logseq DB, Tana, Schema.org → Comprehensive Analysis
I want to export using the UI (not CLI) → UI Export Guide
🔗 External Resources
Logseq Database
Schema.org
Tana
🤝 Contributing to Documentation
Found a typo? Want to improve clarity? Documentation contributions are welcome!
- Fork the repository
- Edit the relevant file in
docs/ - Submit a pull request
Style Guide:
- Use clear, concise language
- Include code examples where helpful
- Add links to related documentation
- Keep formatting consistent
📞 Getting Help
- GitHub Issues: Report bugs or request features
- Logseq Forums: Community discussion
- Documentation: You're already here! 📚
Last Updated: November 2025 Maintained By: Logseq Template Graph Contributors