System Map

Docit can now render a local architecture graph for your Rails API. It connects routes, controllers, actions, documentation coverage, schemas, models, and source references so engineers can understand how the app fits together.

Available routes

Path	Purpose
`/api-docs/system`	Interactive architecture map with search, filters, draggable nodes, manual arrows, selected-node AI guidance, and PNG export.
`/api-docs/system.json`	Raw graph payload for exports, internal tools, and future editor integrations.

What the graph includes

Routes mapped to controller actions
Controller-to-action relationships
Docit documentation coverage for each action
Schema nodes from Docit.define_schema
Loaded ActiveRecord models and associations
Service, job, and mailer nodes from local source folders
Evidence and confidence on every edge

Configuration

Docit.configure do |config|
  config.system_graph_enabled = true
  config.system_graph_excluded_paths = [
    "app/controllers/internal/"
  ]
end

Design direction

The map uses Docit's dark visual language: void background, ember accents, dusk highlights, and clean node cards. The goal is a smooth diagram workspace similar in spirit to Excalidraw or dbdiagram, but grounded in real Rails and Docit metadata.

Diagram controls

Drag nodes to create more space and make flows easier to read.
Connect Nodes lets you add your own arrows when Docit cannot infer a relationship.
AI Mode lets you select controllers/endpoints, then generate a beginner-friendly diagram guide.
Export PNG downloads the current diagram state as an image.

AI diagram guidance

AI does not replace the deterministic graph. Docit builds the graph from Rails and local source first, then AI explains the selected flow, calls out confusing areas, and suggests which arrows/containers matter most.