# dfinity/portal architecture

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

- Interactive diagram: https://gitdiagram.com/dfinity/portal
- Repository: https://github.com/dfinity/portal

## Overview

This archived repository is the DFINITY ICP developer portal: a documentation and learning site with a custom search system. The main search path runs from indexed HTML through document extraction and index construction/upload, then from the site’s search UI through an IC actor to search results. The tree also shows navigation, homepage, blog, and shared site chrome. Source excerpts support the search calls and upload path; unsampled search internals and broader site wiring are represented only where the tree or README supports them.

Main entry points: [`search/src/search-cli/src/main.rs`](https://github.com/dfinity/portal/blob/master/search/src/search-cli/src/main.rs) (Index and upload CLI), [`src/components/Common/Search/actor.ts`](https://github.com/dfinity/portal/blob/master/src/components/Common/Search/actor.ts) (Canister actor), [`src/components/Common/Search/Search.tsx`](https://github.com/dfinity/portal/blob/master/src/components/Common/Search/Search.tsx) (Search UI), [`search/src/doc_generator/generate-docs.py`](https://github.com/dfinity/portal/blob/master/search/src/doc_generator/generate-docs.py) (Document generator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_portal["Developer portal"]
  node_docs_navigation["Docs navigation<br/>[sidebars.js]"]
  node_docs_home["Docs homepage<br/>[index.tsx]"]
  node_blog["Blog views<br/>[index.js]"]
  node_site_footer["Site footer<br/>[index.js]"]
  node_search_ui["Search UI<br/>[Search.tsx]"]
end

subgraph group_search_build["Search indexing"]
  node_html_docs["Built HTML docs"]
  node_doc_generator["Document generator<br/>[generate-docs.py]"]
  node_extractor["HTML extractor<br/>[extractor.py]"]
  node_search_cli["Index and upload CLI<br/>[main.rs]"]
  node_index_core["Search index core<br/>[lib.rs]"]
  node_cli_results["CLI result output<br/>[print_results.rs]"]
end

subgraph group_search_runtime["Search runtime"]
  node_search_actor["Canister actor<br/>[actor.ts]"]
  node_search_idl["Search interface<br/>[search.did.js]"]
  node_search_canister[("Search canister<br/>[lib.rs]")]
end

node_developer(("Developer"))
node_ic_service{{"IC canister service"}}

node_developer -.->|"browses docs"| node_docs_navigation
node_developer -.->|"visits"| node_docs_home
node_developer -.->|"reads posts"| node_blog
node_developer -.->|"searches"| node_search_ui
node_doc_generator -->|"extracts with"| node_extractor
node_html_docs -->|"provides HTML"| node_doc_generator
node_search_cli -->|"builds index"| node_index_core
node_search_cli -->|"prints results"| node_cli_results
node_search_cli -->|"uploads index"| node_search_canister
node_search_ui -->|"queries"| node_search_actor
node_search_actor -->|"uses interface"| node_search_idl
node_search_actor -.->|"sends actor calls"| node_ic_service
node_ic_service -.->|"routes queries"| node_search_canister

click node_docs_navigation "https://github.com/dfinity/portal/blob/master/sidebars.js"
click node_docs_home "https://github.com/dfinity/portal/blob/master/src/components/DocsHome/index.tsx"
click node_blog "https://github.com/dfinity/portal/blob/master/src/theme/BlogPostItems/index.js"
click node_site_footer "https://github.com/dfinity/portal/blob/master/src/theme/Footer/index.js"
click node_search_ui "https://github.com/dfinity/portal/blob/master/src/components/Common/Search/Search.tsx"
click node_doc_generator "https://github.com/dfinity/portal/blob/master/search/src/doc_generator/generate-docs.py"
click node_extractor "https://github.com/dfinity/portal/blob/master/search/src/doc_generator/lib/extractor.py"
click node_search_cli "https://github.com/dfinity/portal/blob/master/search/src/search-cli/src/main.rs"
click node_index_core "https://github.com/dfinity/portal/blob/master/search/src/search/src/lib.rs"
click node_cli_results "https://github.com/dfinity/portal/blob/master/search/src/search-cli/src/print_results.rs"
click node_search_actor "https://github.com/dfinity/portal/blob/master/src/components/Common/Search/actor.ts"
click node_search_idl "https://github.com/dfinity/portal/blob/master/search/src/declarations/search/search.did.js"
click node_search_canister "https://github.com/dfinity/portal/blob/master/search/src/search_canister/src/lib.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_docs_navigation,node_docs_home,node_blog,node_site_footer,node_search_ui toneBlue
class node_html_docs,node_doc_generator,node_extractor,node_search_cli,node_index_core,node_cli_results toneAmber
class node_search_actor,node_search_idl,node_search_canister toneMint
class node_developer,node_ic_service toneIndigo
```

## Components

### Developer portal

- [Docs navigation](https://github.com/dfinity/portal/blob/master/sidebars.js): `sidebars.js`
- [Docs homepage](https://github.com/dfinity/portal/blob/master/src/components/DocsHome/index.tsx): `src/components/DocsHome/index.tsx`
- [Blog views](https://github.com/dfinity/portal/blob/master/src/theme/BlogPostItems/index.js): `src/theme/BlogPostItems/index.js`
- [Site footer](https://github.com/dfinity/portal/blob/master/src/theme/Footer/index.js): `src/theme/Footer/index.js`
- [Search UI](https://github.com/dfinity/portal/blob/master/src/components/Common/Search/Search.tsx): `src/components/Common/Search/Search.tsx`

### Search indexing

- **Built HTML docs**
- [Document generator](https://github.com/dfinity/portal/blob/master/search/src/doc_generator/generate-docs.py): `search/src/doc_generator/generate-docs.py`
- [HTML extractor](https://github.com/dfinity/portal/blob/master/search/src/doc_generator/lib/extractor.py): `search/src/doc_generator/lib/extractor.py`
- [Index and upload CLI](https://github.com/dfinity/portal/blob/master/search/src/search-cli/src/main.rs): `search/src/search-cli/src/main.rs`
- [Search index core](https://github.com/dfinity/portal/blob/master/search/src/search/src/lib.rs): `search/src/search/src/lib.rs`
- [CLI result output](https://github.com/dfinity/portal/blob/master/search/src/search-cli/src/print_results.rs): `search/src/search-cli/src/print_results.rs`

### Search runtime

- [Canister actor](https://github.com/dfinity/portal/blob/master/src/components/Common/Search/actor.ts): `src/components/Common/Search/actor.ts`
- [Search interface](https://github.com/dfinity/portal/blob/master/search/src/declarations/search/search.did.js): `search/src/declarations/search/search.did.js`
- [Search canister](https://github.com/dfinity/portal/blob/master/search/src/search_canister/src/lib.rs): `search/src/search_canister/src/lib.rs`

### Other components

- **Developer**
- **IC canister service**

## Connections

- Developer → Docs navigation: browses docs (evidence: `sidebars.js`)
- Developer → Docs homepage: visits (evidence: `src/components/DocsHome/index.tsx`)
- Developer → Blog views: reads posts (evidence: `src/theme/BlogPostItems/index.js`)
- Developer → Search UI: searches (evidence: `src/components/Common/Search/Search.tsx`)
- Document generator → HTML extractor: extracts with (evidence: `search/src/doc_generator/generate-docs.py`)
- Built HTML docs → Document generator: provides HTML (evidence: `search/src/doc_generator/generate-docs.py`)
- Index and upload CLI → Search index core: builds index (evidence: `search/src/search-cli/src/main.rs`)
- Index and upload CLI → CLI result output: prints results (evidence: `search/src/search-cli/src/main.rs`)
- Index and upload CLI → Search canister: uploads index (evidence: `search/src/search-cli/src/main.rs`)
- Search UI → Canister actor: queries (evidence: `src/components/Common/Search/Search.tsx`)
- Canister actor → Search interface: uses interface (evidence: `src/components/Common/Search/actor.ts`)
- Canister actor → IC canister service: sends actor calls
- IC canister service → Search canister: routes queries
