Documentation source for SkyCMS — a multi-tenant ASP.NET Core content management system with four visual editors (WYSIWYG, drag-and-drop page builder, code editor, image editor), multi-cloud storage, pluggable identity providers, and static-site publishing.
Published at: docs.sky-cms.com
The site is organized by audience role so readers find content relevant to their work:
| Folder | Audience | Topics | Description |
|---|---|---|---|
| getting-started/ | Everyone | 3 | What is SkyCMS, key concepts, quick start |
| for-editors/ | Editors, Authors | 30 | Content creation, all four editors, blogging, publishing, collaboration, file management |
| for-site-builders/ | Site Builders | 7 | Layouts, templates, pages, widgets, style guides |
| for-developers/ | Developers | 18 | Architecture, APIs, multi-tenancy, EF Core cross-provider, middleware pipeline |
| installation/ | Administrators | 14 | Setup wizard (6 steps), Azure/AWS/Docker/Cloudflare deployment, local dev |
| configuration/ | Administrators | 7+ | Database, storage, CDN, email providers, multi-tenancy, proxy settings |
| deployment/ | DevOps | 8 | Cloud hosting, CI/CD pipelines, Docker, demo deployment, licensing |
| reference/ | All | 9 | Feature catalog, changelog, FAQ, glossary, troubleshooting, templates |
The Feature Catalog provides a comprehensive inventory of all 56 documented features across 8 categories, with jump-to navigation and cross-reference links to the relevant documentation pages.
- Getting Started — Quick Start
- Installation Overview
- Feature Catalog
- FAQ
- Troubleshooting
- Glossary
- Changelog
For AI assistants, retrieval systems, or prompt grounding, start with AI Context Pack. It summarizes canonical SkyCMS terminology, disambiguation rules, and the most authoritative docs to consult next.
The MkDocs configuration lives in the parent SkyCMS repo at mkdocs.yml, which references this content via docs_dir.
- Python 3.8+
- pip
pip install mkdocs-materialFrom the SkyCMS repo root (not this repo):
cd /path/to/SkyCMS
mkdocs serveThen open http://127.0.0.1:8000 in your browser.
Note: The
mkdocs.ymlnav references a legacyDocs/folder structure. Some paths in the nav may differ from the folder layout in this repo. See Deployment for how the published site is built.
Place new documentation based on the target audience:
| If the reader is a... | Put it in... |
|---|---|
| Content editor or author | for-editors/ |
| Site builder working with layouts/templates | for-site-builders/ |
| Developer extending or integrating SkyCMS | for-developers/ |
| Administrator installing or configuring | installation/ or configuration/ |
| DevOps engineer deploying or managing CI/CD | deployment/ |
Use YAML frontmatter at the top of every new or materially revised documentation file. This gives MkDocs, search, and AI ingestion a stable, parseable metadata block.
---
canonical_title: Page Builder
description: Visual drag-and-drop composition in SkyCMS using GrapesJS.
audience:
- Content Editors
- Site Builders
doc_type: How-to
status: Draft
entities:
- page-builder
- layers-panel
keywords:
- grapesjs
- drag and drop
- visual editor
---| Field | Purpose |
|---|---|
canonical_title |
Canonical page title used by search and AI context extraction |
description |
One-sentence summary for search snippets and retrieval |
audience |
Intended readers, as a YAML list |
doc_type |
How-to, Explanation, Reference, Tutorial, or Quickstart |
status |
Draft, Canonical, Reference, Deprecated, or other explicit state |
entities |
Canonical SkyCMS concepts covered by the page |
keywords |
Synonyms, aliases, and common search phrases |
Optional fields may be added when helpful, such as source, aliases, related_topics, or tags.
Legacy HTML comments may be retained for internal provenance, but they should not replace YAML frontmatter on new or substantially updated pages.
- Use lowercase with hyphens:
url-management.md,blog-architecture.md - Use
index.mdfor section landing pages - Use
overview.mdfor high-level introductions to a topic area
When adding or updating documentation for a SkyCMS feature, also update the corresponding section in the Feature Catalog and check the Documentation Gaps tracker.
- Be role-focused — Write for the audience specified in the frontmatter. Editors don't need implementation details; developers don't need UI walkthroughs.
- Link, don't duplicate — Reference existing pages rather than repeating content. Use the feature catalog as a cross-reference hub.
- Use tables for structured data — Configuration options, parameters, comparison matrices.
- Include code examples — Use fenced code blocks with language identifiers (
csharp,bash,powershell,yaml,json). - Add "See Also" sections — End pages with links to related documentation.
Documentation is automatically deployed when changes are pushed to the Docs/** path in the SkyCMS repo:
- The
deploy-docs-cloudflare.ymlGitHub Actions workflow triggers - MkDocs builds the static site
- Pre-deployment link validation runs
- Built files are uploaded to Cloudflare R2
- Post-deployment link validation confirms the live site
See CI/CD Pipelines for full pipeline documentation.