How cpayne624/dokno works
Main Components
a) Core Engine Components:
• Models Layer
• Article
• Category
• ArticleSlug
• Log
• Controllers Layer
• Articles Controller
• Categories Controller
• Views Layer
• Article views
• Category views
• Shared partials
b) Integration Components:
• Host Rails Application
• Database
• User Authentication System (configurable)
┌─ Host Rails Application ─────────────────────────────────┐
• ┌─ Dokno Engine ──────────────────────────────────┐ │
• ┌─ Controllers ─┐ ┌─ Models ──────────┐ │ │
• Articles │ │ Article │ │ │
• Categories │◄───►│ Category │ │ │
• ┘ │ ArticleSlug │ │ │
• ▲ │ Log │ │ │
• ┘ │ │
• ▲ │ │
• ┌─ Views ───┐ │ │ │
• Articles │ │ │ │
• Categories│ │ │ │
• Partials │ │ │ │
• ┘ ▼ │ │
• ┌─ Database ─┐ │ │
• ┘ │ │
• ┘ │
• ▲ │
• ┌─ User System ─┐ │ ┌─ Asset Pipeline ─┐│
• (Configurable)│◄───┘ │ JS & CSS ││
• ┘ └─────────────────┘│
• ┘
Key Relationships to Highlight
• Mount point integration with host Rails app
• Database interactions through ActiveRecord
• User authentication integration
• Asset pipeline integration
• MVC pattern within the engine
Important Implementation Details
• Engine's namespace (Dokno::)
• Mount point configuration
• Article panel integration point
• Markdown processing flow
Additional Elements
• Notes about configuration options
• External dependencies (redcarpet and diffy)