# civo/docs architecture

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

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

## Overview

This repository supplies the content and customizations for Civo’s public documentation site. Readers browse platform guidance through generated navigation or search, then use the relevant instructions for account, infrastructure, and storage tasks. The README documents these product areas; the sampled configuration shows Docusaurus routing, autogenerated navigation, and Typesense search. Source excerpts are limited, so links between specific documentation topics and runtime behavior are not inferred.

Main entry points: [`docusaurus.config.js`](https://github.com/civo/docs/blob/main/docusaurus.config.js) (Typesense search theme), [`content/docs/account`](https://github.com/civo/docs/tree/main/content/docs/account) (Account guidance), [`content/docs/compute`](https://github.com/civo/docs/tree/main/content/docs/compute) (Compute guidance), [`content/docs/database`](https://github.com/civo/docs/tree/main/content/docs/database) (Database guidance)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_content["Documentation content"]
  node_account["Account guidance"]
  node_compute["Compute guidance"]
  node_databases["Database guidance"]
  node_kubernetes["Kubernetes guidance"]
  node_networking["Networking guidance"]
  node_object_storage["Object storage guidance"]
  node_overview["Platform overview"]
  node_faq["FAQs"]
end

subgraph group_site["Site experience"]
  node_docusaurus["Docusaurus site"]
  node_site_config["Site configuration"]
  node_navigation["Sidebar navigation<br/>[sidebars.js]"]
  node_homepage["Homepage content<br/>[index.mdx]"]
  node_footer["Custom footer<br/>[index.js]"]
end

subgraph group_integration["Search integration"]
  node_search_theme["Typesense search theme"]
  node_typesense[("Typesense service")]
end

node_reader(("Documentation reader"))

node_reader -->|"visits"| node_docusaurus
node_docusaurus -->|"uses settings"| node_site_config
node_docusaurus -->|"loads navigation"| node_navigation
node_docusaurus -->|"renders"| node_homepage
node_docusaurus -->|"renders"| node_footer
node_docusaurus -->|"serves guidance"| node_account
node_docusaurus -->|"serves guidance"| node_compute
node_docusaurus -->|"serves guidance"| node_databases
node_docusaurus -->|"serves guidance"| node_kubernetes
node_docusaurus -->|"serves guidance"| node_networking
node_docusaurus -->|"serves guidance"| node_object_storage
node_docusaurus -->|"serves guidance"| node_overview
node_docusaurus -->|"serves guidance"| node_faq
node_docusaurus -->|"loads theme"| node_search_theme
node_search_theme -.->|"queries"| node_typesense

click node_site_config "https://github.com/civo/docs/blob/main/docusaurus.config.js"
click node_navigation "https://github.com/civo/docs/blob/main/sidebars.js"
click node_homepage "https://github.com/civo/docs/blob/main/content/index.mdx"
click node_footer "https://github.com/civo/docs/blob/main/src/theme/Footer/index.js"
click node_account "https://github.com/civo/docs/tree/main/content/docs/account"
click node_compute "https://github.com/civo/docs/tree/main/content/docs/compute"
click node_databases "https://github.com/civo/docs/tree/main/content/docs/database"
click node_kubernetes "https://github.com/civo/docs/tree/main/content/docs/kubernetes"
click node_networking "https://github.com/civo/docs/tree/main/content/docs/networking"
click node_object_storage "https://github.com/civo/docs/tree/main/content/docs/object-stores"
click node_overview "https://github.com/civo/docs/tree/main/content/docs/overview"
click node_faq "https://github.com/civo/docs/tree/main/content/docs/faq"
click node_search_theme "https://github.com/civo/docs/blob/main/docusaurus.config.js"

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_account,node_compute,node_databases,node_kubernetes,node_networking,node_object_storage,node_overview,node_faq toneBlue
class node_docusaurus,node_site_config,node_navigation,node_homepage,node_footer toneAmber
class node_search_theme,node_typesense toneMint
class node_reader toneIndigo
```

## Components

### Documentation content

- [Account guidance](https://github.com/civo/docs/tree/main/content/docs/account): `content/docs/account`
- [Compute guidance](https://github.com/civo/docs/tree/main/content/docs/compute): `content/docs/compute`
- [Database guidance](https://github.com/civo/docs/tree/main/content/docs/database): `content/docs/database`
- [Kubernetes guidance](https://github.com/civo/docs/tree/main/content/docs/kubernetes): `content/docs/kubernetes`
- [Networking guidance](https://github.com/civo/docs/tree/main/content/docs/networking): `content/docs/networking`
- [Object storage guidance](https://github.com/civo/docs/tree/main/content/docs/object-stores): `content/docs/object-stores`
- [Platform overview](https://github.com/civo/docs/tree/main/content/docs/overview): `content/docs/overview`
- [FAQs](https://github.com/civo/docs/tree/main/content/docs/faq): `content/docs/faq`

### Site experience

- **Docusaurus site**
- [Site configuration](https://github.com/civo/docs/blob/main/docusaurus.config.js): `docusaurus.config.js`
- [Sidebar navigation](https://github.com/civo/docs/blob/main/sidebars.js): `sidebars.js`
- [Homepage content](https://github.com/civo/docs/blob/main/content/index.mdx): `content/index.mdx`
- [Custom footer](https://github.com/civo/docs/blob/main/src/theme/Footer/index.js): `src/theme/Footer/index.js`

### Search integration

- [Typesense search theme](https://github.com/civo/docs/blob/main/docusaurus.config.js): `docusaurus.config.js`
- **Typesense service**

### Other components

- **Documentation reader**

## Connections

- Documentation reader → Docusaurus site: visits
- Docusaurus site → Site configuration: uses settings
- Docusaurus site → Sidebar navigation: loads navigation
- Docusaurus site → Homepage content: renders
- Docusaurus site → Custom footer: renders
- Docusaurus site → Account guidance: serves guidance
- Docusaurus site → Compute guidance: serves guidance
- Docusaurus site → Database guidance: serves guidance
- Docusaurus site → Kubernetes guidance: serves guidance
- Docusaurus site → Networking guidance: serves guidance
- Docusaurus site → Object storage guidance: serves guidance
- Docusaurus site → Platform overview: serves guidance
- Docusaurus site → FAQs: serves guidance
- Docusaurus site → Typesense search theme: loads theme
- Typesense search theme → Typesense service: queries