# remnawave/panel architecture

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

- Interactive diagram: https://gitdiagram.com/remnawave/panel
- Repository: https://github.com/remnawave/panel

## Overview

This repository is Remnawave’s Docusaurus documentation site, describing a proxy-management product built on Xray-core. Readers browse installation and learning material, product capabilities, integrations, and SDK guides; the site also presents client and community-project catalogs. The tree and README establish these content areas, while sampled source shows reusable catalog cards, navigation widgets, and theme components. Several content-page and component-to-page wiring points were not sampled, so those links are omitted rather than inferred.

Main entry points: [`src/components/GitHubStars/index.tsx`](https://github.com/remnawave/panel/blob/main/src/components/GitHubStars/index.tsx) (GitHub Stars), [`src/components/ClientCard/index.tsx`](https://github.com/remnawave/panel/blob/main/src/components/ClientCard/index.tsx) (Client Card), [`src/components/ProjectCard/index.tsx`](https://github.com/remnawave/panel/blob/main/src/components/ProjectCard/index.tsx) (Project Card), [`src/theme/Logo/index.tsx`](https://github.com/remnawave/panel/blob/main/src/theme/Logo/index.tsx) (Site Logo)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_product_docs["Product Documentation"]
  node_docs_site["Documentation Site"]
  node_install_guides["Installation Guides"]
  node_learn_guides["Learning Guides"]
  node_feature_guides["Feature Guides"]
  node_sdk_guides["SDK Guides"]
end

subgraph group_catalogs["Catalog Experience"]
  node_client_catalog["Client Catalog<br/>[clients.mdx]"]
  node_project_catalog["Project Catalog"]
  node_client_data["Client Listings<br/>[clients.ts]"]
  node_client_card["Client Card<br/>[index.tsx]"]
  node_clients_list["Client List<br/>[index.tsx]"]
  node_project_card["Project Card<br/>[index.tsx]"]
  node_projects_grid["Project Grid<br/>[index.tsx]"]
end

subgraph group_site_ui["Site Components"]
  node_github_stars["GitHub Stars<br/>[index.tsx]"]
  node_category_nav["Category Navigation<br/>[index.tsx]"]
  node_category_section["Category Section<br/>[index.tsx]"]
  node_feature_highlight["Feature Highlights<br/>[index.tsx]"]
  node_hero_section["Hero Section<br/>[index.tsx]"]
  node_release_entry["Release Entry<br/>[index.tsx]"]
end

subgraph group_theme["Theme"]
  node_doc_card["Document Card<br/>[index.tsx]"]
  node_site_logo["Site Logo<br/>[index.tsx]"]
  node_logo_art["Logo Artwork<br/>[remnawave-logo.tsx]"]
  node_mdx_components["MDX Components<br/>[MDXComponents.tsx]"]
end

node_reader(("Reader"))
node_github_api(("Ungh Repository API"))
node_browser_storage[("Browser Local Storage")]

node_reader -->|"browses"| node_docs_site
node_client_card -->|"renders"| node_github_stars
node_project_card -->|"renders"| node_github_stars
node_github_stars -->|"reads and writes"| node_browser_storage
node_github_stars -->|"fetches stars"| node_github_api
node_site_logo -->|"renders"| node_logo_art

click node_docs_site "https://github.com/remnawave/panel/tree/main/docs"
click node_install_guides "https://github.com/remnawave/panel/tree/main/docs/install"
click node_learn_guides "https://github.com/remnawave/panel/tree/main/docs/learn"
click node_feature_guides "https://github.com/remnawave/panel/tree/main/docs/features"
click node_sdk_guides "https://github.com/remnawave/panel/tree/main/docs/sdk"
click node_client_catalog "https://github.com/remnawave/panel/blob/main/docs/clients.mdx"
click node_project_catalog "https://github.com/remnawave/panel/blob/main/docs/awesome-remnawave.mdx"
click node_client_data "https://github.com/remnawave/panel/blob/main/src/data/clients.ts"
click node_client_card "https://github.com/remnawave/panel/blob/main/src/components/ClientCard/index.tsx"
click node_clients_list "https://github.com/remnawave/panel/blob/main/src/components/ClientsList/index.tsx"
click node_project_card "https://github.com/remnawave/panel/blob/main/src/components/ProjectCard/index.tsx"
click node_projects_grid "https://github.com/remnawave/panel/blob/main/src/components/ProjectsGrid/index.tsx"
click node_github_stars "https://github.com/remnawave/panel/blob/main/src/components/GitHubStars/index.tsx"
click node_category_nav "https://github.com/remnawave/panel/blob/main/src/components/CategoryNav/index.tsx"
click node_category_section "https://github.com/remnawave/panel/blob/main/src/components/CategorySection/index.tsx"
click node_feature_highlight "https://github.com/remnawave/panel/blob/main/src/components/FeatureHighlight/index.tsx"
click node_hero_section "https://github.com/remnawave/panel/blob/main/src/components/HeroSection/index.tsx"
click node_release_entry "https://github.com/remnawave/panel/blob/main/src/components/ReleaseEntry/index.tsx"
click node_doc_card "https://github.com/remnawave/panel/blob/main/src/theme/DocCard/index.tsx"
click node_site_logo "https://github.com/remnawave/panel/blob/main/src/theme/Logo/index.tsx"
click node_logo_art "https://github.com/remnawave/panel/blob/main/src/theme/Logo/remnawave-logo.tsx"
click node_mdx_components "https://github.com/remnawave/panel/blob/main/src/theme/MDXComponents.tsx"

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_site,node_install_guides,node_learn_guides,node_feature_guides,node_sdk_guides toneBlue
class node_client_catalog,node_project_catalog,node_client_data,node_client_card,node_clients_list,node_project_card,node_projects_grid,node_browser_storage toneAmber
class node_github_stars,node_category_nav,node_category_section,node_feature_highlight,node_hero_section,node_release_entry,node_github_api toneMint
class node_doc_card,node_site_logo,node_logo_art,node_mdx_components toneRose
class node_reader toneIndigo
```

## Components

### Product Documentation

- [Documentation Site](https://github.com/remnawave/panel/tree/main/docs): `docs`
- [Installation Guides](https://github.com/remnawave/panel/tree/main/docs/install): `docs/install`
- [Learning Guides](https://github.com/remnawave/panel/tree/main/docs/learn): `docs/learn`
- [Feature Guides](https://github.com/remnawave/panel/tree/main/docs/features): `docs/features`
- [SDK Guides](https://github.com/remnawave/panel/tree/main/docs/sdk): `docs/sdk`

### Catalog Experience

- [Client Catalog](https://github.com/remnawave/panel/blob/main/docs/clients.mdx): `docs/clients.mdx`
- [Project Catalog](https://github.com/remnawave/panel/blob/main/docs/awesome-remnawave.mdx): `docs/awesome-remnawave.mdx`
- [Client Listings](https://github.com/remnawave/panel/blob/main/src/data/clients.ts): `src/data/clients.ts`
- [Client Card](https://github.com/remnawave/panel/blob/main/src/components/ClientCard/index.tsx): `src/components/ClientCard/index.tsx`
- [Client List](https://github.com/remnawave/panel/blob/main/src/components/ClientsList/index.tsx): `src/components/ClientsList/index.tsx`
- [Project Card](https://github.com/remnawave/panel/blob/main/src/components/ProjectCard/index.tsx): `src/components/ProjectCard/index.tsx`
- [Project Grid](https://github.com/remnawave/panel/blob/main/src/components/ProjectsGrid/index.tsx): `src/components/ProjectsGrid/index.tsx`

### Site Components

- [GitHub Stars](https://github.com/remnawave/panel/blob/main/src/components/GitHubStars/index.tsx): `src/components/GitHubStars/index.tsx`
- [Category Navigation](https://github.com/remnawave/panel/blob/main/src/components/CategoryNav/index.tsx): `src/components/CategoryNav/index.tsx`
- [Category Section](https://github.com/remnawave/panel/blob/main/src/components/CategorySection/index.tsx): `src/components/CategorySection/index.tsx`
- [Feature Highlights](https://github.com/remnawave/panel/blob/main/src/components/FeatureHighlight/index.tsx): `src/components/FeatureHighlight/index.tsx`
- [Hero Section](https://github.com/remnawave/panel/blob/main/src/components/HeroSection/index.tsx): `src/components/HeroSection/index.tsx`
- [Release Entry](https://github.com/remnawave/panel/blob/main/src/components/ReleaseEntry/index.tsx): `src/components/ReleaseEntry/index.tsx`

### Theme

- [Document Card](https://github.com/remnawave/panel/blob/main/src/theme/DocCard/index.tsx): `src/theme/DocCard/index.tsx`
- [Site Logo](https://github.com/remnawave/panel/blob/main/src/theme/Logo/index.tsx): `src/theme/Logo/index.tsx`
- [Logo Artwork](https://github.com/remnawave/panel/blob/main/src/theme/Logo/remnawave-logo.tsx): `src/theme/Logo/remnawave-logo.tsx`
- [MDX Components](https://github.com/remnawave/panel/blob/main/src/theme/MDXComponents.tsx): `src/theme/MDXComponents.tsx`

### Other components

- **Reader**
- **Ungh Repository API**
- **Browser Local Storage**

## Connections

- Reader → Documentation Site: browses (evidence: `README.md`)
- Client Card → GitHub Stars: renders (evidence: `src/components/ClientCard/index.tsx`)
- Project Card → GitHub Stars: renders (evidence: `src/components/ProjectCard/index.tsx`)
- GitHub Stars → Browser Local Storage: reads and writes (evidence: `src/components/GitHubStars/index.tsx`)
- GitHub Stars → Ungh Repository API: fetches stars (evidence: `src/components/GitHubStars/index.tsx`)
- Site Logo → Logo Artwork: renders (evidence: `src/theme/Logo/index.tsx`)
