# cloudstack-llc/msty-studio-docs architecture

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

- Interactive diagram: https://gitdiagram.com/cloudstack-llc/msty-studio-docs
- Repository: https://github.com/cloudstack-llc/msty-studio-docs

## Overview

This project is best drawn as a **content-driven Nuxt documentation site / product knowledge portal**, not as a traditional backend-heavy application. The key architectural idea is: **Markdown content in `content/` is rendered by a Nuxt frontend into a polished docs experience using reusable Vue components and Tailwind styling**.

At a high level, the system is:

- **End users** reading documentation in a browser
- A **Nuxt 3 app** serving routes and rendering pages
- A **content layer** made of Markdown files under `content/`
- **Reusable UI/content components** under `components/`
- **Static assets** under `assets/` and `public/`
- A **build/export pipeline** that compiles the docs site and also generates a consolidated text export
- A **CI/CD deployment path** via GitHub Actions and Cloudflare-style config (`wrangler.jsonc`)

- **docs content ingestion**
- **frontend rendering**
- **build/deploy pipeline**
- **static hosting/external delivery**

##### Client / Consumer
- **Browser / Reader**
- The primary consumer of the documentation site
- Interacts with routes like `/getting-started/...`, `/features/...`, etc.

##### Nuxt application layer
- **Nuxt 3 app**
- Main application shell
- Defined by `nuxt.config.ts`, `app.config.ts`
- Handles routing, rendering, content integration, and build-time generation

- **Page router**
- `pages/[...slug].vue`
- Important because it indicates a **catch-all route** used to render docs pages dynamically from content slugs

##### Content system
- **Markdown content repository**
- `content/1.getting-started/*`
- `content/2.features/*`
- `content/3.enterprise/*`
- `content/4.how-tos/*`
- This is the core knowledge base of the app

- **Content navigation metadata**
- `_dir.yml` files
- These likely define ordering and section structure for the docs sidebar/nav

##### Static assets
- **Public assets**
- `public/images/*`

- **Generated docs artifact**
- `public/studio-docs.txt`
- Produced by the export script and served as a static file

##### Build / export pipeline
- **Markdown aggregation script**
- `scripts/build-studio-docs.cjs`
- Collects all Markdown files in `content/`
- Removes YAML frontmatter
- Generates `public/studio-docs.txt`

- **Package/build system**
- `bun.lock`, `pnpm-lock.yaml`, `package.json`
- Indicates dependency management and reproducible builds

##### Deployment / CI-CD
- **GitHub Actions**
- `.github/workflows/deploy.yml`
- Main deployment automation
- Potentially also `nuxthub.yml.disabled` as an alternate/disabled deployment path

- **Cloudflare deployment config**
- `wrangler.jsonc`
- Strong indicator the app is deployed to a Cloudflare platform target or compatible worker/pages setup

##### File-based routing
The presence of `pages/[...slug].vue` suggests route handling is driven by file structure and slug matching. This is a key Nuxt pattern and should be shown.

##### Separation of concerns
- content authoring (`content/`)
- rendering (`pages/`, `components/`)
- styling (`assets/`)
- static media (`public/`)
- automation (`scripts/`, `.github/workflows/`)

##### Reusable documentation components
The `components/content/` folder indicates the docs are not pure Markdown; they are enhanced with interactive or branded components. Show these as a layer between Markdown and final UI.

##### Technologies/frameworks to label

Labels where relevant:

- **Nuxt 3**
- **Vue**
- **TypeScript**
- **Tailwind CSS**
- **Markdown / Content files**
- **GitHub Actions**
- **Cloudflare / Wrangler**
- **Bun** and/or **pnpm** for package management
- **shadcn-docs-nuxt** as the docs starter/framework basis

- **Browser → Nuxt app** for page requests
- **Nuxt app → content files** for content resolution
- **Markdown content → Vue content components** where MD files embed those components
- **Assets/public images → rendered pages** for screenshots/media
- **Build script → public/studio-docs.txt** for export generation
- **GitHub Actions → deployment target** for CI/CD publication

- `nuxt.config.ts` and `app.config.ts` influencing app behavior
- `tailwind.config.js` influencing styling
- `content/_dir.yml` influencing nav/sidebar ordering

##### What not to overemphasize

- databases
- message queues
- authentication services
- backend microservices
- REST/GraphQL APIs

unless you discover them elsewhere, because this repository does not clearly contain them. The architecture here is primarily **docs site + content pipeline + deployment automation**.

##### Best way to visually separate the project into components

- Browser
- Nuxt runtime
- Route resolver
- Docs page renderer
- Markdown content store
- Navigation metadata
- Embedded Vue content components
- Tailwind styling
- Static images
- Export script
- CI workflow
- Deployment platform

##### Summary recommendation

- a **Nuxt-based documentation portal**
- driven by **Markdown content**
- enhanced by **Vue content components**
- styled with **Tailwind**
- exported via a **content aggregation script**
- built and deployed through **GitHub Actions + Cloudflare/Wrangler**

**“Content is authored in Markdown, rendered by a Nuxt 3 docs app, enhanced by reusable Vue components, styled with Tailwind, and deployed as a static/hybrid documentation site.”**

## Diagram (Mermaid)

```mermaid
flowchart TD
  %% Users
  Browser["Browser / Reader"]:::user

  %% Application layer
  subgraph "Nuxt 3 Documentation App"
    AppShell["Nuxt 3 App Shell"]:::app
    Router["Catch-all Docs Page Router<br/>pages/[...slug].vue"]:::app
    DocsRenderer["Docs Page Renderer"]:::app
    ThemeBase["Docs Starter / Theme Base"]:::theme
    ContentComponents["Reusable Content Components"]:::component
    AurumTag["AurumTag"]:::component
    Resources["Resources"]:::component
    YouTubePlayer["YouTubePlayer"]:::component
  end

  %% Content layer
  subgraph "Content Sources"
    ContentRepo["Markdown Content Repository"]:::content
    GettingStarted["Getting Started"]:::content
    Features["Features"]:::content
    Enterprise["Enterprise"]:::content
    HowTos["How-Tos"]:::content
    DirMeta["Content Navigation Metadata<br/>_dir.yml"]:::meta
  end

  %% Styling / assets
  subgraph "Presentation & Static Assets"
    Tailwind["Tailwind Styling Layer"]:::styling
    StaticImages["Public Static Images"]:::asset
  end

  %% Build / export
  subgraph "Build & Export Pipeline"
    ExportScript["Markdown Aggregation / Export Script"]:::build
    ExportedDocs["Exported Docs Artifact<br/>studio-docs.txt"]:::artifact
    PackageMgmt["Package / Build Management"]:::build
    TypeScriptCfg["TypeScript Configuration"]:::build
  end

  %% Deployment
  subgraph "CI/CD & Hosting"
    GitHubActions["CI/CD Workflow"]:::deploy
    DisabledWorkflow["Alternate Disabled Deployment Workflow"]:::deploy
    Wrangler["Cloudflare / Wrangler Deployment Config"]:::deploy
    DeployTarget["Static Hosting / Cloudflare Delivery"]:::deploy
  end

  %% Runtime flow
  Browser -->|"requests docs routes"| AppShell
  AppShell -->|"renders"| Router
  Router -->|"loads matching content"| ContentRepo
  ContentRepo -->|"sectioned by"| GettingStarted
  ContentRepo -->|"sectioned by"| Features
  ContentRepo -->|"sectioned by"| Enterprise
  ContentRepo -->|"sectioned by"| HowTos
  DirMeta -->|"orders / structures nav"| AppShell
  Router -->|"renders page content"| DocsRenderer
  DocsRenderer -->|"embeds components"| ContentComponents
  ContentComponents --> AurumTag
  ContentComponents --> Resources
  ContentComponents --> YouTubePlayer
  Tailwind -->|"styles UI"| AppShell
  Tailwind -->|"styles content"| DocsRenderer
  StaticImages -->|"supplies visuals"| DocsRenderer
  ThemeBase -->|"provides docs theme primitives"| AppShell
  ThemeBase -->|"provides shared layout"| DocsRenderer

  %% Build-time flow
  PackageMgmt -->|"installs / builds"| AppShell
  TypeScriptCfg -->|"type-checks / compiles"| AppShell
  ExportScript -->|"scans markdown from"| ContentRepo
  ExportScript -->|"writes consolidated text"| ExportedDocs
  ContentRepo -->|"source of truth"| ExportScript

  %% CI/CD flow
  GitHubActions -->|"runs build and deploy"| AppShell
  GitHubActions -->|"can trigger export"| ExportScript
  GitHubActions -->|"publishes via"| Wrangler
  DisabledWorkflow -.->|"alternate path"| Wrangler
  Wrangler -->|"deploys to"| DeployTarget
  ExportedDocs -->|"served as static file"| DeployTarget

  %% Click events
  click Browser "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/README.md"
  click AppShell "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/nuxt.config.ts"
  click Router "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/pages/[...slug].vue"
  click ContentRepo "https://github.com/cloudstack-llc/msty-studio-docs/tree/prod/content/"
  click GettingStarted "https://github.com/cloudstack-llc/msty-studio-docs/tree/prod/content/1.getting-started/"
  click Features "https://github.com/cloudstack-llc/msty-studio-docs/tree/prod/content/2.features/"
  click Enterprise "https://github.com/cloudstack-llc/msty-studio-docs/tree/prod/content/3.enterprise/"
  click HowTos "https://github.com/cloudstack-llc/msty-studio-docs/tree/prod/content/4.how-tos/"
  click DirMeta "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/content/*/_dir.yml"
  click ContentComponents "https://github.com/cloudstack-llc/msty-studio-docs/tree/prod/components/content/"
  click AurumTag "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/components/content/AurumTag.vue"
  click Resources "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/components/content/Resources.vue"
  click YouTubePlayer "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/components/content/YouTubePlayer.vue"
  click Tailwind "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/assets/css/tailwind.css"
  click StaticImages "https://github.com/cloudstack-llc/msty-studio-docs/tree/prod/public/images/"
  click ExportedDocs "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/public/studio-docs.txt"
  click ExportScript "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/scripts/build-studio-docs.cjs"
  click GitHubActions "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/.github/workflows/deploy.yml"
  click DisabledWorkflow "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/.github/workflows/nuxthub.yml.disabled"
  click Wrangler "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/wrangler.jsonc"
  click PackageMgmt "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/package.json"
  click TypeScriptCfg "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/tsconfig.json"
  click ThemeBase "https://github.com/cloudstack-llc/msty-studio-docs/blob/prod/nuxt.config.ts"

  %% Styles
  classDef user fill:#dbeafe,stroke:#2563eb,stroke-width:2px,color:#0f172a;
  classDef app fill:#dcfce7,stroke:#16a34a,stroke-width:2px,color:#0f172a;
  classDef content fill:#fef3c7,stroke:#d97706,stroke-width:2px,color:#0f172a;
  classDef meta fill:#fde68a,stroke:#b45309,stroke-width:2px,color:#0f172a;
  classDef component fill:#ede9fe,stroke:#7c3aed,stroke-width:2px,color:#0f172a;
  classDef styling fill:#cffafe,stroke:#0891b2,stroke-width:2px,color:#0f172a;
  classDef asset fill:#fce7f3,stroke:#db2777,stroke-width:2px,color:#0f172a;
  classDef build fill:#e0f2fe,stroke:#0284c7,stroke-width:2px,color:#0f172a;
  classDef artifact fill:#fae8ff,stroke:#a21caf,stroke-width:2px,color:#0f172a;
  classDef deploy fill:#fee2e2,stroke:#dc2626,stroke-width:2px,color:#0f172a;
  classDef theme fill:#e2e8f0,stroke:#475569,stroke-width:2px,color:#0f172a;
```
