# monkey/monkey-docs architecture

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

- Interactive diagram: https://gitdiagram.com/monkey/monkey-docs
- Repository: https://github.com/monkey/monkey-docs

## Overview

This repository is Monkey’s documentation, not the HTTP server implementation. Its main user workflow is reading topic-specific guides; the README also documents rendering the Markdown source with GitBook. The tree identifies the documented subject areas, but no source excerpts show links or runtime interactions between them, so those relationships are not inferred.

Main entry points: [`src/README.md`](https://github.com/monkey/monkey-docs/blob/master/src/README.md) (Documentation)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_start["Getting started"]
  node_install["Installation guides<br/>[README.md]"]
end

subgraph group_config["Server configuration"]
  node_configguides["Configuration guides<br/>[README.md]"]
  node_virtualhosts["Virtual hosts<br/>[README.md]"]
end

subgraph group_plugins["Plugins"]
  node_plugin_guides["Plugin guides<br/>[README.md]"]
end

subgraph group_operations["Operations"]
  node_debugging["Debugging guides<br/>[README.md]"]
  node_embedded["Embedded platforms<br/>[README.md]"]
end

subgraph group_reference["Project reference"]
  node_about["About Monkey<br/>[README.md]"]
end

node_reader(("Reader"))
node_docs["Documentation<br/>[README.md]"]
node_gitbook["GitBook renderer"]

node_reader -->|"reads"| node_docs
node_docs -->|"rendered by"| node_gitbook

click node_docs "https://github.com/monkey/monkey-docs/blob/master/src/README.md"
click node_install "https://github.com/monkey/monkey-docs/blob/master/src/getting_started/README.md"
click node_configguides "https://github.com/monkey/monkey-docs/blob/master/src/configuration/README.md"
click node_virtualhosts "https://github.com/monkey/monkey-docs/blob/master/src/virtualhosts/README.md"
click node_plugin_guides "https://github.com/monkey/monkey-docs/blob/master/src/plugins/README.md"
click node_debugging "https://github.com/monkey/monkey-docs/blob/master/src/debugging/README.md"
click node_embedded "https://github.com/monkey/monkey-docs/blob/master/src/embedded/README.md"
click node_about "https://github.com/monkey/monkey-docs/blob/master/src/about/README.md"

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_install toneBlue
class node_configguides,node_virtualhosts toneAmber
class node_plugin_guides toneMint
class node_debugging,node_embedded toneRose
class node_about,node_reader,node_gitbook toneIndigo
class node_docs toneTeal
```

## Components

### Getting started

- [Installation guides](https://github.com/monkey/monkey-docs/blob/master/src/getting_started/README.md): `src/getting_started/README.md`

### Server configuration

- [Configuration guides](https://github.com/monkey/monkey-docs/blob/master/src/configuration/README.md): `src/configuration/README.md`
- [Virtual hosts](https://github.com/monkey/monkey-docs/blob/master/src/virtualhosts/README.md): `src/virtualhosts/README.md`

### Plugins

- [Plugin guides](https://github.com/monkey/monkey-docs/blob/master/src/plugins/README.md): `src/plugins/README.md`

### Operations

- [Debugging guides](https://github.com/monkey/monkey-docs/blob/master/src/debugging/README.md): `src/debugging/README.md`
- [Embedded platforms](https://github.com/monkey/monkey-docs/blob/master/src/embedded/README.md): `src/embedded/README.md`

### Project reference

- [About Monkey](https://github.com/monkey/monkey-docs/blob/master/src/about/README.md): `src/about/README.md`

### Other components

- **Reader**
- [Documentation](https://github.com/monkey/monkey-docs/blob/master/src/README.md): `src/README.md`
- **GitBook renderer**

## Connections

- Reader → Documentation: reads (evidence: `README.md`)
- Documentation → GitBook renderer: rendered by (evidence: `README.md`)
