How roblox/creator-docs works
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: main.ts Check runner · links.ts Link checks · localization.ts Localization checks · engineReferenceChecks.ts Engine reference checks
Components 24
Documentation content
- Guides
content/en-us - Tutorials
content/en-us - Education
content/en-us/education - API reference
content/en-us/reference - Navigation data
content/common/navigation
Content checks
- Check runner
tools/checks/main.ts - Link checks
tools/checks/utils/links.ts - Localization checks
tools/checks/utils/localization.ts - Engine reference checks
tools/checks/utils/engineReferenceChecks.ts - OpenAPI validation
tools/checks/utils/openapi/validator.ts - Markdown analysis
tools/checks/utils/unified.ts
Check support
- Check utilities
tools/checks/utils - Content file access
tools/checks/utils/files.ts - Git file selection
tools/checks/utils/git.ts - Checker configuration
tools/checks/utils/config.ts - GitHub feedback
tools/checks/utils/github.ts - Check summaries
tools/checks/utils/console.ts - MDX imports
tools/checks/utils/imports.ts - Manifest handling
tools/checks/utils/manifest.ts - Markdown linting
tools/checks/utils/markdownlint.ts - JSON checks
tools/checks/utils/json.ts - Array helpers
tools/checks/utils/array.ts - Word checks
tools/checks/utils/words.ts
Other components
- Contributors
Connections 26
- Contributors → Guides: edit
README.md - Contributors → Tutorials: author
README.md - Contributors → Education: contribute
README.md - Contributors → API reference: view source
README.md - Guides → Check runner: content checked
tools/checks/main.ts - Tutorials → Check runner: content checked
tools/checks/main.ts - Check runner → Checker configuration: loads options
tools/checks/main.ts - Check runner → Content file access: enumerates files
tools/checks/main.ts - Check runner → Git file selection: selects changed files
tools/checks/main.ts - Check runner → Link checks: runs link checks
tools/checks/main.ts - Check runner → Localization checks: checks translations
tools/checks/main.ts - Check runner → Engine reference checks: checks YAML
tools/checks/main.ts - Check runner → OpenAPI validation: validates schemas
tools/checks/main.ts - Check runner → Markdown analysis: analyzes Markdown
tools/checks/main.ts - Check runner → Check summaries: records results
tools/checks/main.ts - Check runner → GitHub feedback: posts feedback
tools/checks/main.ts - Link checks → Content file access: reads content
tools/checks/utils/links.ts - Link checks → MDX imports: extracts imports
tools/checks/utils/links.ts - Localization checks → MDX imports: compares imports
tools/checks/utils/localization.ts - Localization checks → Markdown analysis: compares components
tools/checks/utils/localization.ts - Engine reference checks → GitHub feedback: comments on errors
tools/checks/utils/engineReferenceChecks.ts - Engine reference checks → Check summaries: adds requirements
tools/checks/utils/engineReferenceChecks.ts - OpenAPI validation → GitHub feedback: comments on errors
tools/checks/utils/openapi/validator.ts - OpenAPI validation → Check summaries: adds requirements
tools/checks/utils/openapi/validator.ts - Markdown analysis → Word checks: filters words
tools/checks/utils/unified.ts - Git file selection → Content file access: filters extensions
tools/checks/utils/git.ts