# p-rer/ymm-api-docs architecture

> Architecture diagram of the GitHub repository p-rer/ymm-api-docs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/p-rer/ymm-api-docs
- Repository: https://github.com/p-rer/ymm-api-docs

## Overview

YMM API Docs is a documentation site for Yukkuri Movie Maker’s plugin API, with Markdown guides and YAML-based API references. The main workflow resolves a document slug, loads and renders its content, then presents it in a navigable documentation layout. Readers can also search, preview internal links, and request AI summaries. API-reference rendering and document metadata/contributor handling are distinct supporting stages. Relationships involving unsampled components are omitted or marked unverified where appropriate.

Main entry points: [`lib/docs.ts`](https://github.com/p-rer/ymm-api-docs/blob/master/lib/docs.ts) (Document loading), [`lib/api-docs/render-api-doc.ts`](https://github.com/p-rer/ymm-api-docs/blob/master/lib/api-docs/render-api-doc.ts) (API doc rendering), [`app/[...slug]/page.tsx`](https://github.com/p-rer/ymm-api-docs/blob/master/app/%5B...slug%5D/page.tsx) (Document page), [`lib/doc-markdown.ts`](https://github.com/p-rer/ymm-api-docs/blob/master/lib/doc-markdown.ts) (Markdown access)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_reader["Reader experience"]
  node_home["Home page<br/>[page.tsx]"]
  node_docpage["Document page<br/>[page.tsx]"]
  node_layout["Documentation layout<br/>[docs-layout.tsx]"]
  node_clientlayout["Interactive navigation"]
  node_searchhook["Full-text search"]
  node_summaryui["Summary display<br/>[AiSummary.tsx]"]
end

subgraph group_content["Content rendering"]
  node_docstore["Document loading<br/>[docs.ts]"]
  node_markdown["Markdown access<br/>[doc-markdown.ts]"]
  node_contributors["Contributor metadata"]
  node_docdata["Documentation content"]
end

subgraph group_api["API references"]
  node_yaml["YAML documents<br/>[yaml-docs.ts]"]
  node_apirender["API doc rendering<br/>[render-api-doc.ts]"]
  node_schema["YAML schema<br/>[yaml-v1-schema.ts]"]
  node_symbolindex["Symbol index<br/>[symbol-index.ts]"]
  node_typenode["Type model<br/>[type-node.ts]"]
  node_referenceurl["Reference URLs<br/>[reference-url.ts]"]
end

subgraph group_services["Document services"]
  node_searchapi["Search API<br/>[route.ts]"]
  node_previewapi["Link preview API<br/>[route.ts]"]
  node_previewrender["Preview text rendering<br/>[doc-preview.ts]"]
  node_summaryapi["Summary API<br/>[route.ts]"]
  node_imageapi["Content images<br/>[route.ts]"]
  node_searchindex["Search index data"]
end

subgraph group_shared["Shared presentation"]
  node_og["Open Graph images<br/>[og.tsx]"]
end

node_reader(("Documentation reader"))
node_googleai["Google AI"]

node_reader -->|"opens"| node_home
node_reader -->|"opens"| node_docpage
node_home -->|"loads documents"| node_docstore
node_docpage -->|"loads document"| node_docstore
node_docpage -->|"renders through"| node_layout
node_docpage -->|"generates metadata image"| node_og
node_docstore -->|"reads Markdown"| node_markdown
node_docstore -->|"converts YAML"| node_yaml
node_docstore -->|"renders API docs"| node_apirender
node_docstore -->|"resolves contributors"| node_contributors
node_layout -->|"renders"| node_clientlayout
node_clientlayout -->|"uses"| node_searchhook
node_searchhook -->|"requests search"| node_searchapi
node_searchapi -->|"loads"| node_searchindex
node_apirender -->|"validates with"| node_schema
node_apirender -->|"uses"| node_symbolindex
node_apirender -->|"uses"| node_typenode
node_apirender -->|"uses"| node_referenceurl
node_previewapi -->|"loads source"| node_markdown
node_previewapi -->|"renders preview"| node_previewrender
node_summaryapi -->|"loads article"| node_markdown
node_summaryapi -->|"generates summary"| node_googleai
node_summaryui -.->|"requests summary"| node_summaryapi
node_docstore -.->|"reads content"| node_docdata
node_markdown -.->|"reads content"| node_docdata
node_reader -.->|"requests images"| node_imageapi

click node_home "https://github.com/p-rer/ymm-api-docs/blob/master/app/page.tsx"
click node_docpage "https://github.com/p-rer/ymm-api-docs/blob/master/app/%5B...slug%5D/page.tsx"
click node_layout "https://github.com/p-rer/ymm-api-docs/blob/master/app/docs-layout.tsx"
click node_clientlayout "https://github.com/p-rer/ymm-api-docs/blob/master/components/DocsLayoutClient.tsx"
click node_searchhook "https://github.com/p-rer/ymm-api-docs/blob/master/hooks/useFullTextSearch.ts"
click node_searchapi "https://github.com/p-rer/ymm-api-docs/blob/master/app/api/search/route.ts"
click node_docstore "https://github.com/p-rer/ymm-api-docs/blob/master/lib/docs.ts"
click node_markdown "https://github.com/p-rer/ymm-api-docs/blob/master/lib/doc-markdown.ts"
click node_yaml "https://github.com/p-rer/ymm-api-docs/blob/master/lib/yaml-docs.ts"
click node_apirender "https://github.com/p-rer/ymm-api-docs/blob/master/lib/api-docs/render-api-doc.ts"
click node_schema "https://github.com/p-rer/ymm-api-docs/blob/master/lib/api-docs/yaml-v1-schema.ts"
click node_symbolindex "https://github.com/p-rer/ymm-api-docs/blob/master/lib/api-docs/symbol-index.ts"
click node_typenode "https://github.com/p-rer/ymm-api-docs/blob/master/lib/api-docs/type-node.ts"
click node_referenceurl "https://github.com/p-rer/ymm-api-docs/blob/master/lib/api-docs/reference-url.ts"
click node_previewapi "https://github.com/p-rer/ymm-api-docs/blob/master/app/api/doc-preview/route.ts"
click node_previewrender "https://github.com/p-rer/ymm-api-docs/blob/master/lib/doc-preview.ts"
click node_summaryapi "https://github.com/p-rer/ymm-api-docs/blob/master/app/api/summarize/route.ts"
click node_summaryui "https://github.com/p-rer/ymm-api-docs/blob/master/components/AiSummary.tsx"
click node_contributors "https://github.com/p-rer/ymm-api-docs/blob/master/lib/doc-contributors.ts"
click node_og "https://github.com/p-rer/ymm-api-docs/blob/master/lib/og.tsx"
click node_imageapi "https://github.com/p-rer/ymm-api-docs/blob/master/app/content-images/%5B...path%5D/route.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_home,node_docpage,node_layout,node_clientlayout,node_searchhook,node_summaryui toneBlue
class node_docstore,node_markdown,node_contributors,node_docdata toneAmber
class node_yaml,node_apirender,node_schema,node_symbolindex,node_typenode,node_referenceurl toneMint
class node_searchapi,node_previewapi,node_previewrender,node_summaryapi,node_imageapi,node_searchindex toneRose
class node_og,node_reader,node_googleai toneIndigo
```

## Components

### Reader experience

- [Home page](https://github.com/p-rer/ymm-api-docs/blob/master/app/page.tsx): `app/page.tsx`
- [Document page](https://github.com/p-rer/ymm-api-docs/blob/master/app/%5B...slug%5D/page.tsx): `app/[...slug]/page.tsx`
- [Documentation layout](https://github.com/p-rer/ymm-api-docs/blob/master/app/docs-layout.tsx): `app/docs-layout.tsx`
- [Interactive navigation](https://github.com/p-rer/ymm-api-docs/blob/master/components/DocsLayoutClient.tsx): `components/DocsLayoutClient.tsx`
- [Full-text search](https://github.com/p-rer/ymm-api-docs/blob/master/hooks/useFullTextSearch.ts): `hooks/useFullTextSearch.ts`
- [Summary display](https://github.com/p-rer/ymm-api-docs/blob/master/components/AiSummary.tsx): `components/AiSummary.tsx`

### Content rendering

- [Document loading](https://github.com/p-rer/ymm-api-docs/blob/master/lib/docs.ts): `lib/docs.ts`
- [Markdown access](https://github.com/p-rer/ymm-api-docs/blob/master/lib/doc-markdown.ts): `lib/doc-markdown.ts`
- [Contributor metadata](https://github.com/p-rer/ymm-api-docs/blob/master/lib/doc-contributors.ts): `lib/doc-contributors.ts`
- **Documentation content**

### API references

- [YAML documents](https://github.com/p-rer/ymm-api-docs/blob/master/lib/yaml-docs.ts): `lib/yaml-docs.ts`
- [API doc rendering](https://github.com/p-rer/ymm-api-docs/blob/master/lib/api-docs/render-api-doc.ts): `lib/api-docs/render-api-doc.ts`
- [YAML schema](https://github.com/p-rer/ymm-api-docs/blob/master/lib/api-docs/yaml-v1-schema.ts): `lib/api-docs/yaml-v1-schema.ts`
- [Symbol index](https://github.com/p-rer/ymm-api-docs/blob/master/lib/api-docs/symbol-index.ts): `lib/api-docs/symbol-index.ts`
- [Type model](https://github.com/p-rer/ymm-api-docs/blob/master/lib/api-docs/type-node.ts): `lib/api-docs/type-node.ts`
- [Reference URLs](https://github.com/p-rer/ymm-api-docs/blob/master/lib/api-docs/reference-url.ts): `lib/api-docs/reference-url.ts`

### Document services

- [Search API](https://github.com/p-rer/ymm-api-docs/blob/master/app/api/search/route.ts): `app/api/search/route.ts`
- [Link preview API](https://github.com/p-rer/ymm-api-docs/blob/master/app/api/doc-preview/route.ts): `app/api/doc-preview/route.ts`
- [Preview text rendering](https://github.com/p-rer/ymm-api-docs/blob/master/lib/doc-preview.ts): `lib/doc-preview.ts`
- [Summary API](https://github.com/p-rer/ymm-api-docs/blob/master/app/api/summarize/route.ts): `app/api/summarize/route.ts`
- [Content images](https://github.com/p-rer/ymm-api-docs/blob/master/app/content-images/%5B...path%5D/route.ts): `app/content-images/[...path]/route.ts`
- **Search index data**

### Shared presentation

- [Open Graph images](https://github.com/p-rer/ymm-api-docs/blob/master/lib/og.tsx): `lib/og.tsx`

### Other components

- **Documentation reader**
- **Google AI**

## Connections

- Documentation reader → Home page: opens (evidence: `app/page.tsx`)
- Documentation reader → Document page: opens (evidence: `app/[...slug]/page.tsx`)
- Home page → Document loading: loads documents (evidence: `app/page.tsx`)
- Document page → Document loading: loads document (evidence: `app/[...slug]/page.tsx`)
- Document page → Documentation layout: renders through (evidence: `app/[...slug]/page.tsx`)
- Document page → Open Graph images: generates metadata image (evidence: `app/[...slug]/page.tsx`)
- Document loading → Markdown access: reads Markdown (evidence: `lib/docs.ts`)
- Document loading → YAML documents: converts YAML (evidence: `lib/docs.ts`)
- Document loading → API doc rendering: renders API docs (evidence: `lib/docs.ts`)
- Document loading → Contributor metadata: resolves contributors (evidence: `lib/docs.ts`)
- Documentation layout → Interactive navigation: renders (evidence: `app/docs-layout.tsx`)
- Interactive navigation → Full-text search: uses (evidence: `components/DocsLayoutClient.tsx`)
- Full-text search → Search API: requests search (evidence: `hooks/useFullTextSearch.ts`)
- Search API → Search index data: loads (evidence: `app/api/search/route.ts`)
- API doc rendering → YAML schema: validates with
- API doc rendering → Symbol index: uses
- API doc rendering → Type model: uses
- API doc rendering → Reference URLs: uses
- Link preview API → Markdown access: loads source (evidence: `app/api/doc-preview/route.ts`)
- Link preview API → Preview text rendering: renders preview (evidence: `app/api/doc-preview/route.ts`)
- Summary API → Markdown access: loads article (evidence: `app/api/summarize/route.ts`)
- Summary API → Google AI: generates summary (evidence: `app/api/summarize/route.ts`)
- Summary display → Summary API: requests summary
- Document loading → Documentation content: reads content
- Markdown access → Documentation content: reads content
- Documentation reader → Content images: requests images
