# scottidler/riki architecture

> Architecture diagram of the GitHub repository scottidler/riki, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/scottidler/riki
- Repository: https://github.com/scottidler/riki

## Overview

riki is a Git-backed Markdown wiki: readers request pages that the server renders from the wiki’s validated good commit, while editors load, modify, and save pages through the same URL. Saves create Git commits and publish only index-valid tips; a background poller fetches upstream changes. The graph includes the documented editor capabilities and service subsystems, but unsampled source limits some internal call relationships, which are left unconnected rather than inferred.

Main entry points: [`core/src/wiki.rs`](https://github.com/scottidler/riki/blob/main/core/src/wiki.rs) (Wiki publish), [`editor/src/setup.ts`](https://github.com/scottidler/riki/blob/main/editor/src/setup.ts) (Editor setup), [`server/src/routes.rs`](https://github.com/scottidler/riki/blob/main/server/src/routes.rs) (HTTP routes), [`server/src/pages.rs`](https://github.com/scottidler/riki/blob/main/server/src/pages.rs) (Page handlers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_server["HTTP service"]
  node_routes["HTTP routes<br/>[routes.rs]"]
  node_pages["Page handlers<br/>[pages.rs]"]
  node_api["Save API<br/>[api.rs]"]
  node_html["HTML assembly<br/>[render.rs]"]
  node_assets["Editor assets<br/>[assets.rs]"]
  node_config["Service config<br/>[config.rs]"]
  node_identity["Request identity<br/>[identity.rs]"]
end

subgraph group_core["Wiki core"]
  node_wiki["Wiki publish<br/>[wiki.rs]"]
  node_git_store[("Git content store<br/>[store.rs]")]
  node_nav_index["Navigation index<br/>[index.rs]"]
  node_markdown["Markdown rendering<br/>[render.rs]"]
  node_page_model["Page model<br/>[page.rs]"]
  node_path_rules["Path validation<br/>[path.rs]"]
  node_save_logic["Save logic<br/>[save.rs]"]
  node_runtime["Runtime status<br/>[runtime.rs]"]
end

subgraph group_editor["Browser editor"]
  node_browser_entry["Editor entry<br/>[main.ts]"]
  node_session["Edit session<br/>[session.ts]"]
  node_editor_api["Editor API client<br/>[api.ts]"]
  node_editor_setup["Editor setup<br/>[setup.ts]"]
  node_toolbar["Editing toolbar<br/>[toolbar.ts]"]
  node_tasks["Task editing<br/>[tasks.ts]"]
  node_alerts["Editor alerts<br/>[alert.ts]"]
  node_images["Image handling<br/>[images.ts]"]
  node_tables["Table editing<br/>[table.ts]"]
  node_page_ui["Page interactions<br/>[ui.ts]"]
end

subgraph group_operations["Operations"]
  node_poller["Upstream poller<br/>[poller.rs]"]
end

node_reader(("Wiki reader"))
node_editor_user(("Editor user"))
node_upstream[("Git upstream")]

node_reader -->|"requests pages"| node_routes
node_editor_user -->|"starts editing"| node_browser_entry
node_routes -->|"routes page requests"| node_pages
node_routes -->|"merges API routes"| node_api
node_routes -->|"routes assets"| node_assets
node_pages -.->|"reads wiki state"| node_wiki
node_pages -->|"renders content"| node_markdown
node_pages -->|"assembles response"| node_html
node_html -->|"uses page tree"| node_nav_index
node_api -->|"resolves identity"| node_identity
node_api -.->|"saves page"| node_save_logic
node_save_logic -->|"commits changes"| node_git_store
node_save_logic -->|"publishes saved tip"| node_wiki
node_wiki -->|"fetches and reads"| node_git_store
node_wiki -->|"builds index"| node_nav_index
node_wiki -->|"extracts titles"| node_markdown
node_git_store -.->|"fetches and pushes"| node_upstream
node_browser_entry -->|"opens session"| node_session
node_session -->|"loads and saves"| node_editor_api
node_session -->|"creates editor"| node_editor_setup
node_session -->|"builds toolbar"| node_toolbar
node_editor_setup -->|"registers alerts"| node_alerts
node_editor_setup -->|"registers images"| node_images
node_editor_setup -->|"registers tables"| node_tables
node_editor_setup -->|"registers task editing"| node_tasks
node_toolbar -->|"uses alert controls"| node_alerts
node_toolbar -->|"uses table controls"| node_tables
node_toolbar -->|"uses task controls"| node_tasks
node_page_ui -.->|"decorates rendered pages"| node_browser_entry
node_poller -.->|"polls for updates"| node_wiki
node_config -->|"configures service"| node_routes
node_path_rules -->|"validates paths"| node_git_store

click node_routes "https://github.com/scottidler/riki/blob/main/server/src/routes.rs"
click node_pages "https://github.com/scottidler/riki/blob/main/server/src/pages.rs"
click node_api "https://github.com/scottidler/riki/blob/main/server/src/api.rs"
click node_html "https://github.com/scottidler/riki/blob/main/server/src/render.rs"
click node_assets "https://github.com/scottidler/riki/blob/main/server/src/assets.rs"
click node_config "https://github.com/scottidler/riki/blob/main/server/src/config.rs"
click node_identity "https://github.com/scottidler/riki/blob/main/server/src/identity.rs"
click node_wiki "https://github.com/scottidler/riki/blob/main/core/src/wiki.rs"
click node_git_store "https://github.com/scottidler/riki/blob/main/core/src/store.rs"
click node_nav_index "https://github.com/scottidler/riki/blob/main/core/src/index.rs"
click node_markdown "https://github.com/scottidler/riki/blob/main/core/src/render.rs"
click node_page_model "https://github.com/scottidler/riki/blob/main/core/src/page.rs"
click node_path_rules "https://github.com/scottidler/riki/blob/main/core/src/path.rs"
click node_save_logic "https://github.com/scottidler/riki/blob/main/core/src/save.rs"
click node_runtime "https://github.com/scottidler/riki/blob/main/core/src/runtime.rs"
click node_browser_entry "https://github.com/scottidler/riki/blob/main/editor/src/main.ts"
click node_session "https://github.com/scottidler/riki/blob/main/editor/src/session.ts"
click node_editor_api "https://github.com/scottidler/riki/blob/main/editor/src/api.ts"
click node_editor_setup "https://github.com/scottidler/riki/blob/main/editor/src/setup.ts"
click node_toolbar "https://github.com/scottidler/riki/blob/main/editor/src/toolbar.ts"
click node_tasks "https://github.com/scottidler/riki/blob/main/editor/src/tasks.ts"
click node_alerts "https://github.com/scottidler/riki/blob/main/editor/src/alert.ts"
click node_images "https://github.com/scottidler/riki/blob/main/editor/src/images.ts"
click node_tables "https://github.com/scottidler/riki/blob/main/editor/src/table.ts"
click node_page_ui "https://github.com/scottidler/riki/blob/main/editor/src/page/ui.ts"
click node_poller "https://github.com/scottidler/riki/blob/main/server/src/poller.rs"

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_routes,node_pages,node_api,node_html,node_assets,node_config,node_identity,node_editor_user toneBlue
class node_wiki,node_git_store,node_nav_index,node_markdown,node_page_model,node_path_rules,node_save_logic,node_runtime,node_upstream toneAmber
class node_browser_entry,node_session,node_editor_api,node_editor_setup,node_toolbar,node_tasks,node_alerts,node_images,node_tables,node_page_ui toneMint
class node_poller toneRose
class node_reader toneIndigo
```

## Components

### HTTP service

- [HTTP routes](https://github.com/scottidler/riki/blob/main/server/src/routes.rs): `server/src/routes.rs`
- [Page handlers](https://github.com/scottidler/riki/blob/main/server/src/pages.rs): `server/src/pages.rs`
- [Save API](https://github.com/scottidler/riki/blob/main/server/src/api.rs): `server/src/api.rs`
- [HTML assembly](https://github.com/scottidler/riki/blob/main/server/src/render.rs): `server/src/render.rs`
- [Editor assets](https://github.com/scottidler/riki/blob/main/server/src/assets.rs): `server/src/assets.rs`
- [Service config](https://github.com/scottidler/riki/blob/main/server/src/config.rs): `server/src/config.rs`
- [Request identity](https://github.com/scottidler/riki/blob/main/server/src/identity.rs): `server/src/identity.rs`

### Wiki core

- [Wiki publish](https://github.com/scottidler/riki/blob/main/core/src/wiki.rs): `core/src/wiki.rs`
- [Git content store](https://github.com/scottidler/riki/blob/main/core/src/store.rs): `core/src/store.rs`
- [Navigation index](https://github.com/scottidler/riki/blob/main/core/src/index.rs): `core/src/index.rs`
- [Markdown rendering](https://github.com/scottidler/riki/blob/main/core/src/render.rs): `core/src/render.rs`
- [Page model](https://github.com/scottidler/riki/blob/main/core/src/page.rs): `core/src/page.rs`
- [Path validation](https://github.com/scottidler/riki/blob/main/core/src/path.rs): `core/src/path.rs`
- [Save logic](https://github.com/scottidler/riki/blob/main/core/src/save.rs): `core/src/save.rs`
- [Runtime status](https://github.com/scottidler/riki/blob/main/core/src/runtime.rs): `core/src/runtime.rs`

### Browser editor

- [Editor entry](https://github.com/scottidler/riki/blob/main/editor/src/main.ts): `editor/src/main.ts`
- [Edit session](https://github.com/scottidler/riki/blob/main/editor/src/session.ts): `editor/src/session.ts`
- [Editor API client](https://github.com/scottidler/riki/blob/main/editor/src/api.ts): `editor/src/api.ts`
- [Editor setup](https://github.com/scottidler/riki/blob/main/editor/src/setup.ts): `editor/src/setup.ts`
- [Editing toolbar](https://github.com/scottidler/riki/blob/main/editor/src/toolbar.ts): `editor/src/toolbar.ts`
- [Task editing](https://github.com/scottidler/riki/blob/main/editor/src/tasks.ts): `editor/src/tasks.ts`
- [Editor alerts](https://github.com/scottidler/riki/blob/main/editor/src/alert.ts): `editor/src/alert.ts`
- [Image handling](https://github.com/scottidler/riki/blob/main/editor/src/images.ts): `editor/src/images.ts`
- [Table editing](https://github.com/scottidler/riki/blob/main/editor/src/table.ts): `editor/src/table.ts`
- [Page interactions](https://github.com/scottidler/riki/blob/main/editor/src/page/ui.ts): `editor/src/page/ui.ts`

### Operations

- [Upstream poller](https://github.com/scottidler/riki/blob/main/server/src/poller.rs): `server/src/poller.rs`

### Other components

- **Wiki reader**
- **Editor user**
- **Git upstream**

## Connections

- Wiki reader → HTTP routes: requests pages (evidence: `README.md`)
- Editor user → Editor entry: starts editing (evidence: `editor/src/main.ts`)
- HTTP routes → Page handlers: routes page requests (evidence: `server/src/routes.rs`)
- HTTP routes → Save API: merges API routes (evidence: `server/src/routes.rs`)
- HTTP routes → Editor assets: routes assets (evidence: `server/src/routes.rs`)
- Page handlers → Wiki publish: reads wiki state
- Page handlers → Markdown rendering: renders content (evidence: `server/src/pages.rs`)
- Page handlers → HTML assembly: assembles response (evidence: `server/src/pages.rs`)
- HTML assembly → Navigation index: uses page tree (evidence: `server/src/render.rs`)
- Save API → Request identity: resolves identity (evidence: `server/src/api.rs`)
- Save API → Save logic: saves page
- Save logic → Git content store: commits changes (evidence: `core/src/save.rs`)
- Save logic → Wiki publish: publishes saved tip (evidence: `core/src/save.rs`)
- Wiki publish → Git content store: fetches and reads (evidence: `core/src/wiki.rs`)
- Wiki publish → Navigation index: builds index (evidence: `core/src/wiki.rs`)
- Wiki publish → Markdown rendering: extracts titles (evidence: `core/src/wiki.rs`)
- Git content store → Git upstream: fetches and pushes
- Editor entry → Edit session: opens session (evidence: `editor/src/main.ts`)
- Edit session → Editor API client: loads and saves (evidence: `editor/src/session.ts`)
- Edit session → Editor setup: creates editor (evidence: `editor/src/session.ts`)
- Edit session → Editing toolbar: builds toolbar (evidence: `editor/src/session.ts`)
- Editor setup → Editor alerts: registers alerts (evidence: `editor/src/setup.ts`)
- Editor setup → Image handling: registers images (evidence: `editor/src/setup.ts`)
- Editor setup → Table editing: registers tables (evidence: `editor/src/setup.ts`)
- Editor setup → Task editing: registers task editing (evidence: `editor/src/setup.ts`)
- Editing toolbar → Editor alerts: uses alert controls (evidence: `editor/src/toolbar.ts`)
- Editing toolbar → Table editing: uses table controls (evidence: `editor/src/toolbar.ts`)
- Editing toolbar → Task editing: uses task controls (evidence: `editor/src/toolbar.ts`)
- Page interactions → Editor entry: decorates rendered pages
- Upstream poller → Wiki publish: polls for updates
- Service config → HTTP routes: configures service (evidence: `server/src/config.rs`)
- Path validation → Git content store: validates paths (evidence: `core/src/store.rs`)
