# roblox/creator-docs architecture

> Architecture diagram of the GitHub repository roblox/creator-docs, 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/roblox/creator-docs
- Repository: https://github.com/roblox/creator-docs

## Overview

Roblox Creator Documentation is a content repository for guides, tutorials, education material, and a read-only Engine API reference. The central contributor workflow is to edit documentation under content/, then submit changes for review; the README describes online and offline contribution routes. A separate TypeScript checker selects content files and runs documentation checks, including links, localization, Markdown analysis, and API-schema validation. Its source is sampled; the broader content areas are identified from the tree and README rather than inspected individually.

Main entry points: [`tools/checks/main.ts`](https://github.com/roblox/creator-docs/blob/main/tools/checks/main.ts) (Check runner), [`tools/checks/utils/links.ts`](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/links.ts) (Link checks), [`tools/checks/utils/localization.ts`](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/localization.ts) (Localization checks), [`tools/checks/utils/engineReferenceChecks.ts`](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/engineReferenceChecks.ts) (Engine reference checks)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_docs["Documentation content"]
  node_guides["Guides"]
  node_tutorials["Tutorials"]
  node_education["Education"]
  node_api_reference["API reference"]
  node_navigation["Navigation data"]
end

subgraph group_checks["Content checks"]
  node_checker["Check runner<br/>[main.ts]"]
  node_link_checks["Link checks<br/>[links.ts]"]
  node_localization["Localization checks<br/>[localization.ts]"]
  node_engine_reference["Engine reference checks"]
  node_openapi["OpenAPI validation<br/>[validator.ts]"]
  node_markdown_analysis["Markdown analysis<br/>[unified.ts]"]
end

subgraph group_check_support["Check support"]
  node_check_utils["Check utilities"]
  node_file_access["Content file access<br/>[files.ts]"]
  node_git_selection["Git file selection<br/>[git.ts]"]
  node_configuration["Checker configuration<br/>[config.ts]"]
  node_github_feedback["GitHub feedback<br/>[github.ts]"]
  node_summaries["Check summaries<br/>[console.ts]"]
  node_imports["MDX imports<br/>[imports.ts]"]
  node_manifest["Manifest handling<br/>[manifest.ts]"]
  node_markdownlint["Markdown linting<br/>[markdownlint.ts]"]
  node_json_checks["JSON checks<br/>[json.ts]"]
  node_arrays["Array helpers<br/>[array.ts]"]
  node_word_checks["Word checks<br/>[words.ts]"]
end

node_contributors(("Contributors"))

node_contributors -->|"edit"| node_guides
node_contributors -->|"author"| node_tutorials
node_contributors -->|"contribute"| node_education
node_contributors -->|"view source"| node_api_reference
node_guides -->|"content checked"| node_checker
node_tutorials -->|"content checked"| node_checker
node_checker -->|"loads options"| node_configuration
node_checker -->|"enumerates files"| node_file_access
node_checker -->|"selects changed files"| node_git_selection
node_checker -->|"runs link checks"| node_link_checks
node_checker -->|"checks translations"| node_localization
node_checker -->|"checks YAML"| node_engine_reference
node_checker -->|"validates schemas"| node_openapi
node_checker -->|"analyzes Markdown"| node_markdown_analysis
node_checker -->|"records results"| node_summaries
node_checker -->|"posts feedback"| node_github_feedback
node_link_checks -->|"reads content"| node_file_access
node_link_checks -->|"extracts imports"| node_imports
node_localization -->|"compares imports"| node_imports
node_localization -->|"compares components"| node_markdown_analysis
node_engine_reference -->|"comments on errors"| node_github_feedback
node_engine_reference -->|"adds requirements"| node_summaries
node_openapi -->|"comments on errors"| node_github_feedback
node_openapi -->|"adds requirements"| node_summaries
node_markdown_analysis -->|"filters words"| node_word_checks
node_git_selection -->|"filters extensions"| node_file_access

click node_guides "https://github.com/roblox/creator-docs/tree/main/content/en-us"
click node_tutorials "https://github.com/roblox/creator-docs/tree/main/content/en-us"
click node_education "https://github.com/roblox/creator-docs/tree/main/content/en-us/education"
click node_api_reference "https://github.com/roblox/creator-docs/tree/main/content/en-us/reference"
click node_navigation "https://github.com/roblox/creator-docs/tree/main/content/common/navigation"
click node_checker "https://github.com/roblox/creator-docs/blob/main/tools/checks/main.ts"
click node_link_checks "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/links.ts"
click node_localization "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/localization.ts"
click node_engine_reference "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/engineReferenceChecks.ts"
click node_openapi "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/openapi/validator.ts"
click node_markdown_analysis "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/unified.ts"
click node_check_utils "https://github.com/roblox/creator-docs/tree/main/tools/checks/utils"
click node_file_access "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/files.ts"
click node_git_selection "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/git.ts"
click node_configuration "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/config.ts"
click node_github_feedback "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/github.ts"
click node_summaries "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/console.ts"
click node_imports "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/imports.ts"
click node_manifest "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/manifest.ts"
click node_markdownlint "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/markdownlint.ts"
click node_json_checks "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/json.ts"
click node_arrays "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/array.ts"
click node_word_checks "https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/words.ts"

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_guides,node_tutorials,node_education,node_api_reference,node_navigation toneBlue
class node_checker,node_link_checks,node_localization,node_engine_reference,node_openapi,node_markdown_analysis toneAmber
class node_check_utils,node_file_access,node_git_selection,node_configuration,node_github_feedback,node_summaries,node_imports,node_manifest,node_markdownlint,node_json_checks,node_arrays,node_word_checks toneMint
class node_contributors toneIndigo
```

## Components

### Documentation content

- [Guides](https://github.com/roblox/creator-docs/tree/main/content/en-us): `content/en-us`
- [Tutorials](https://github.com/roblox/creator-docs/tree/main/content/en-us): `content/en-us`
- [Education](https://github.com/roblox/creator-docs/tree/main/content/en-us/education): `content/en-us/education`
- [API reference](https://github.com/roblox/creator-docs/tree/main/content/en-us/reference): `content/en-us/reference`
- [Navigation data](https://github.com/roblox/creator-docs/tree/main/content/common/navigation): `content/common/navigation`

### Content checks

- [Check runner](https://github.com/roblox/creator-docs/blob/main/tools/checks/main.ts): `tools/checks/main.ts`
- [Link checks](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/links.ts): `tools/checks/utils/links.ts`
- [Localization checks](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/localization.ts): `tools/checks/utils/localization.ts`
- [Engine reference checks](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/engineReferenceChecks.ts): `tools/checks/utils/engineReferenceChecks.ts`
- [OpenAPI validation](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/openapi/validator.ts): `tools/checks/utils/openapi/validator.ts`
- [Markdown analysis](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/unified.ts): `tools/checks/utils/unified.ts`

### Check support

- [Check utilities](https://github.com/roblox/creator-docs/tree/main/tools/checks/utils): `tools/checks/utils`
- [Content file access](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/files.ts): `tools/checks/utils/files.ts`
- [Git file selection](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/git.ts): `tools/checks/utils/git.ts`
- [Checker configuration](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/config.ts): `tools/checks/utils/config.ts`
- [GitHub feedback](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/github.ts): `tools/checks/utils/github.ts`
- [Check summaries](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/console.ts): `tools/checks/utils/console.ts`
- [MDX imports](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/imports.ts): `tools/checks/utils/imports.ts`
- [Manifest handling](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/manifest.ts): `tools/checks/utils/manifest.ts`
- [Markdown linting](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/markdownlint.ts): `tools/checks/utils/markdownlint.ts`
- [JSON checks](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/json.ts): `tools/checks/utils/json.ts`
- [Array helpers](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/array.ts): `tools/checks/utils/array.ts`
- [Word checks](https://github.com/roblox/creator-docs/blob/main/tools/checks/utils/words.ts): `tools/checks/utils/words.ts`

### Other components

- **Contributors**

## Connections

- Contributors → Guides: edit (evidence: `README.md`)
- Contributors → Tutorials: author (evidence: `README.md`)
- Contributors → Education: contribute (evidence: `README.md`)
- Contributors → API reference: view source (evidence: `README.md`)
- Guides → Check runner: content checked (evidence: `tools/checks/main.ts`)
- Tutorials → Check runner: content checked (evidence: `tools/checks/main.ts`)
- Check runner → Checker configuration: loads options (evidence: `tools/checks/main.ts`)
- Check runner → Content file access: enumerates files (evidence: `tools/checks/main.ts`)
- Check runner → Git file selection: selects changed files (evidence: `tools/checks/main.ts`)
- Check runner → Link checks: runs link checks (evidence: `tools/checks/main.ts`)
- Check runner → Localization checks: checks translations (evidence: `tools/checks/main.ts`)
- Check runner → Engine reference checks: checks YAML (evidence: `tools/checks/main.ts`)
- Check runner → OpenAPI validation: validates schemas (evidence: `tools/checks/main.ts`)
- Check runner → Markdown analysis: analyzes Markdown (evidence: `tools/checks/main.ts`)
- Check runner → Check summaries: records results (evidence: `tools/checks/main.ts`)
- Check runner → GitHub feedback: posts feedback (evidence: `tools/checks/main.ts`)
- Link checks → Content file access: reads content (evidence: `tools/checks/utils/links.ts`)
- Link checks → MDX imports: extracts imports (evidence: `tools/checks/utils/links.ts`)
- Localization checks → MDX imports: compares imports (evidence: `tools/checks/utils/localization.ts`)
- Localization checks → Markdown analysis: compares components (evidence: `tools/checks/utils/localization.ts`)
- Engine reference checks → GitHub feedback: comments on errors (evidence: `tools/checks/utils/engineReferenceChecks.ts`)
- Engine reference checks → Check summaries: adds requirements (evidence: `tools/checks/utils/engineReferenceChecks.ts`)
- OpenAPI validation → GitHub feedback: comments on errors (evidence: `tools/checks/utils/openapi/validator.ts`)
- OpenAPI validation → Check summaries: adds requirements (evidence: `tools/checks/utils/openapi/validator.ts`)
- Markdown analysis → Word checks: filters words (evidence: `tools/checks/utils/unified.ts`)
- Git file selection → Content file access: filters extensions (evidence: `tools/checks/utils/git.ts`)
