Diagram to Documentation

Rekhic enables bi-directional architecture workflows: you can design systems visually on the canvas, and then export that topology directly into production-ready Markdown documentation.

---

The Workflow

text Copy
    Architecture Diagram (Canvas)
                 │
                 ▼
        Click "Export Markdown"
                 │
                 ▼
    Markdown Generator Analysis
  (Extracts nodes, types, and edges)
                 │
                 ▼
    Structured Markdown Document
   (System Overview, Components, DBs,
      Relationships / Data Flow)

---

What the Exported Document Contains

Rekhic's MarkdownGenerator inspects your canvas nodes, categories, tech tags, and connectors to construct a structured technical specification:

1. Document Title & Overview

• Uses the diagram title as the primary # System Architecture header.
• Includes the diagram description metadata if provided.

2. Applications

• Lists all nodes designated as client-side applications, SPAs, or frontends, along with their technology badge (e.g. - **Web Client** (Next.js)).

3. Services & APIs

• Catalogs backend services, microservices, and gateway endpoints with their associated runtimes (e.g. - **Order Processing Service** (Spring Boot)).

4. Data Stores

• Lists all databases, distributed caches, and persistent stores (e.g. - **Orders Database** (PostgreSQL)).

5. External Systems

• Documents third-party dependencies and external vendors (e.g. - **Stripe Payments**).

6. Relationships & Data Flow

• Translates every connector and arrow into an explicit flow item:
  • Format: - **Source Component** -> **Target Component** (*Protocol / Label*)
  • Example: - **API Gateway** -> **Order Service** (*HTTPS /api/v1/orders*)
  • Example: - **Order Service** -> **Orders DB** (*SQL write*)

---

How to Export Markdown

1. Open any diagram in the workspace (/diagram).
2. Click the Export Markdown button in the canvas header bar.
3. A modal or download prompt provides the full markdown text.
4. Click Copy to Clipboard or Download as .md.

The resulting file is standard Markdown that renders cleanly inside GitHub repositories (ARCHITECTURE.md), Notion wikis, or Architectural Decision Records (ADRs).

Next: Learn more about Markdown formatting in Exporting Markdown.