How orientechnologies/orientdb-docs works
Project Type and Purpose
• Type: Static documentation site for OrientDB, powered by a markdown site generator (book.toml, src/, theme/).
• Purpose: Produce a versionable, searchable HTML manual that users browse online or offline.
Key Directories and Files
• book.toml ← site generator configuration (metadata, navigation, output settings)
• src/ ← All markdown content, organized by topic/feature (getting started, APIs, internals, etc.)
• theme/ ← Custom templates, CSS, JS, fonts, and handlebars layouts controlling look and feel
• LICENSE, .gitignore ← repository metadata
A. Content Repository
• src/ (Markdown source files, images under src/images/)
• theme/ (Handlebars templates, CSS, JS)
• book.toml (site config, versioning, SUMMARY.md reference)
B. Build Engine
• mdBook (or equivalent CLI)
• Input: src/, theme/, book.toml
• Process: parse Markdown → apply templates → generate HTML/CSS/JS
C. Build Artifacts
• Output folder (e.g., book/ or docs/): fully rendered static site
• Search index (if generated)
D. Deployment/Hosting
• CI/CD pipeline (e.g., GitHub Actions/Travis)
• Hosting platform (GitHub Pages, Netlify, S3 + CloudFront)
E. End Users
• Browser (static HTTP GET)
• Optional offline reader (mdBook “serve” or local folder)
Relationships and Data Flows
• “git push” triggers CI → Build Engine
• Build Engine reads book.toml → loads src/ & theme/ → writes output/
• CI artifacts → Deployment step → Hosting
• Users’ browsers ← HTTP requests → Hosting static files
Architectural Patterns & Principles
• Separation of concerns: Content (md), Presentation (theme), Configuration (book.toml), Processing (build engine), Delivery (host)
• Declarative config + convention‐over‐configuration in folder layout
• Idempotent builds: same inputs = same outputs
• Versioning: book.toml controls version labels, branching strategy for docs versions