How cloudcannon/platform-documentation works
CloudCannon Platform Documentation is a Lume-based documentation site. Readers browse user and developer explanations, guides, glossary entries, release notes, and technical references; reference pages include API operations and generated platform documentation. The graph separates content, page presentation, reference generation, and shared UI. Edges are limited to README statements and visible imports or calls in the supplied excerpts and source index; several major site features are represented by their listed paths, but their internal wiring was not sampled.
Main entry points: guide.tsx Guide layout · openapi.ts API reference model · RelatedArticles.tsx Related resources · user User content
Components 25
Documentation content
- User content
user - Developer content
developer - Glossary
user/glossary
Site presentation
- Base layout
_includes/layouts/base.tsx - Guide layout
_includes/layouts/guide.tsx - Page configuration
_config/markdown-pages.ts - Site search
_components/Layout/Search.tsx - Footer
_components/Layout/Footer.tsx
Technical reference
- API reference model
developer/reference/api/_shared/openapi.ts - API operations
_components/Api/ApiOperation.tsx - Generated references
developer/reference/_shared/referencePageGenerator.ts - Reference navigation
developer/reference/_shared/buildRefNav.ts - CLI reference data
developer/reference/_shared/command-line-interface.ts - Visual Editor API docs
_lib/veapi-docs.ts - Reference entries
_components/Reference/RefItem.tsx - Reference navigation UI
_components/Reference/DocNav.tsx
Shared components
- Code examples
_components/CodeBlock.tsx - Code utilities
_components/utils/code-util.ts - String utilities
_components/utils/string-util.ts - URL utilities
_components/utils/url-util.ts - Related resources
_components/Content/RelatedArticles.tsx
Release history
- Changelog content
changelogs - Changelog index
changelog.page.ts - Filename parser
parseChangelogFilename.ts
Other components
- Documentation readers
Connections 20
- Documentation readers → User content: browse
- Documentation readers → Developer content: browse
- Documentation readers → Glossary: browse
- Documentation readers → Changelog content: browse
- User content → Guide layout: renders with
- Developer content → Guide layout: renders with
- Guide layout → URL utilities: uses
_includes/layouts/guide.tsx - Base layout → Footer: imports
_includes/layouts/base.tsx - Documentation readers → Site search: searches
- API operations → API reference model: uses view models
_components/Api/ApiOperation.tsx - API reference model → String utilities: slugifies with
developer/reference/api/_shared/openapi.ts - Page configuration → API reference model: imports
_config/markdown-pages.ts - Reference navigation → CLI reference data: imports
developer/reference/_shared/buildRefNav.ts - Reference navigation UI → Reference navigation: uses navigation data
_components/Reference/DocNav.tsx - Visual Editor API docs → Generated references: supplies reference entries
_lib/veapi-docs.ts - Reference entries → Generated references: renders reference entries
- Code examples → Code utilities: imports
_components/CodeBlock.tsx - Related resources → String utilities: imports
_components/Content/RelatedArticles.tsx - Related resources → URL utilities: imports
_components/Content/RelatedArticles.tsx - Changelog index → Filename parser: parses filenames
changelog.page.ts