NornicDB Documentation Hub¶
This is the primary navigation page for NornicDB docs.
If you know your goal, start in "Find by task". If you are debugging, start in "Find by issue".
Start Here¶
- New user: Getting Started
- Migrating from Neo4j: Neo4j Migration
- Building apps and queries: User Guides
- Looking for endpoint/function specs: API Reference
- Running in production: Operations
- Security/compliance review: Security, Compliance
- Performance optimization: Performance
Find by Task¶
- Install and run: Quick Start
- Run first queries: First Queries
- Learn Cypher usage patterns: Cypher Queries
- Use vector/hybrid search: Vector Search, Hybrid Search
- Prepare for audit review of background workers and version history: Background Workers, MVCC, and Audit Evidence
- Configure deployment/runtime: Configuration, Environment Variables
- Deploy with Docker: Docker Deployment, Operations Docker
- Observe/operate production: Monitoring, Backup & Restore
- Migrate from Neo4j drivers/schemas: Migration Guide
Find by Issue¶
- Symptom-driven index: Issue Index
- Ops troubleshooting: Operations Troubleshooting
Find by Role¶
Application Developers¶
Platform/SRE Teams¶
Auditors And Reviewers¶
Contributors¶
Documentation Map¶
- Getting Started
- User Guides
- API Reference
- Features
- Operations
- Security
- Compliance
- Performance
- Architecture
- Development
- AI Agents
- Neo4j Migration
- Packaging
- Plans
Canonical Source Policy¶
To avoid drift and duplicated guidance:
- API behavior is canonical in
docs/api-reference/. - Operational runbooks are canonical in
docs/operations/. - Security controls are canonical in
docs/security/. - Compliance interpretation is canonical in
docs/compliance/. - How-to walkthroughs are canonical in
docs/user-guides/.
Section READMEs should summarize and link to canonical pages instead of duplicating full procedures.