Documentation Gaps¶

A running inventory of SkyCMS features that lack dedicated documentation or need improvement. Use this list to prioritize documentation work.

Last updated: Generated from the Feature Catalog cross-reference pass.

How to Use This List¶

Missing — No documentation exists for this feature.
Partial — Some coverage exists (e.g., mentioned in another page) but no dedicated guide.
Needs update — Documentation exists but may be outdated or incomplete.

Each entry links back to the feature catalog section where the gap was identified.

Content Editing & Authoring¶

All content editing & authoring features now have dedicated documentation. See Collaborative Editing Guide for real-time editing, article locking, and presence indicators.

Content Lifecycle & Publishing¶

All content lifecycle features now have dedicated documentation. See Version History, Publishing Modes, URL Management, Content Export & Import, Preload & Caching, and Publishing Progress.

Blogging¶

All blogging features now have dedicated documentation. See Blogging Guide, Blog API Reference, and Blog Architecture.

Site Building¶

No major gaps identified — layouts, templates, pages, widgets, and style guide all have dedicated documentation.

File & Media Management¶

All file & media management features now have dedicated documentation. See Image Processing API and Content Delivery Architecture.

Administration & Security¶

All administration & security features now have dedicated documentation. See User Management Guide, Site Settings Guide, Contact Management Guide, Authentication & SSO Guide, and Audit & Logging Guide.

Multi-Tenancy & Architecture¶

All multi-tenancy & architecture features now have dedicated documentation. See Tenant Isolation Reference, Publisher Architecture, Publisher Rendering Flow, and EF Cross-Provider Guide.

Deployment & Infrastructure¶

All deployment & infrastructure features now have dedicated documentation. See Demo Deployment, CI/CD Pipelines, Cloudflare Edge Hosting, and the documentation operations package: Standards Stack, Metadata Schema, Templates, PR Checklist, Rollout Plan, and Gap Review.

Provider credential setup backlog¶

This follow-up backlog tracks places where SkyCMS depends on provider-issued API tokens, access keys, or service credentials and should provide easy-to-find step-by-step creation instructions.

Status	Area	Scope
DONE	Cloudflare CDN cache purge	Create least-privilege Cloudflare purge token and find the correct zone ID
DONE	Cloudflare R2 credentials	Create bucket-scoped R2 credentials for SkyCMS storage and docs deployment
DONE	Azure credentials and deployment identities — Azure Deployment Credentials	Service principal, managed identity, and deployment secret setup for Azure deployments
DONE	Azure credentials — Azure Blob Credentials, Azure Front Door Credentials, ACS Credentials	Service principal, managed identity, and connection string setup for Azure storage, CDN, and email providers
DONE	AWS credentials — S3 IAM Credentials, CloudFront IAM Credentials	IAM user, policy, and access key setup for S3 storage and CloudFront CDN invalidation
DONE	Email and third-party provider tokens — SendGrid API Key	API key creation and permission scoping for SendGrid transactional email

Summary¶

Category	Documented	Gaps
Content Editing & Authoring	6 of 6 features	0
Content Lifecycle & Publishing	10 of 10 features	0
Blogging	6 of 6 features	0
Site Building	6 of 6 features	0
File & Media Management	4 of 4 features	0
Administration & Security	7 of 7 features	0
Multi-Tenancy & Architecture	7 of 7 features	0
Deployment & Infrastructure	10 of 10 features	0
Total	56 of 56 features	0

All gaps have been filled. Every feature in the catalog now has dedicated documentation.

Mermaid Diagram Backlog¶

This backlog captures high-value pages that currently have no Mermaid diagrams but would benefit from visual relationships, flows, or decision maps.

Priority 1 (high impact)¶

Status	Page	Suggested diagram(s)	Why it helps
DONE	for-developers/tenant-isolation-reference.md	Isolation boundary map, request-to-tenant sequence	Core correctness and security comprehension
DONE	for-developers/content-delivery-architecture.md	Delivery topology, route-to-runtime map	Clarifies static/dynamic/hybrid runtime ownership
DONE	deployment/publishing-workflow.md	Publish sequence, failure and retry flow	Operations and incident response clarity
DONE	deployment/cicd-pipelines.md	Pipeline stages and artifact flow	Faster onboarding for release process
DONE	reference/features/07-multi-tenancy-and-architecture.md	Feature-to-architecture relationship graph	Improves catalog scanning and concept linking
DONE	for-developers/publisher-architecture.md	Component dependency graph	Complements rendering-flow deep dive
DONE	for-developers/article-lifecycle.md	Lifecycle state machine	Faster understanding of content state transitions

Priority 2 (strong value)¶

Status	Page	Suggested diagram(s)	Why it helps
DONE	for-editors/publishing-modes.md	Mode decision tree, scheduling timeline	Better editor decision support
DONE	for-editors/preload-and-caching.md	Cache layers flow, invalidation map	Reduces cache-related confusion
DONE	for-editors/authentication.md	Sign-in and role-check sequence	Easier support and troubleshooting
DONE	configuration/multi-tenancy.md	Configuration precedence flow	Helps administrators debug tenant config
DONE	for-developers/ef-cross-provider-guide.md	Query compatibility decision flow	Makes provider-safe query choices explicit
DONE	for-developers/storage-provider-auto-detection.md	Provider auto-detection flowchart	Clearer diagnostics for provider selection
DONE	reference/features/08-deployment-and-infrastructure.md	Feature-to-deployment capability map	Better cross-reference for planning

Priority 3 (nice to have)¶

Status	Page	Suggested diagram(s)	Why it helps
DONE	configuration/ai/overview.md	AI provider integration topology	Visual comparison of provider paths
DONE	for-developers/ai-integration.md	AI request/response architecture sequence	Faster developer adoption
DONE	for-editors/collaborative-editing.md	Collaboration session sequence	Explains locking and live updates
DONE	for-developers/api/overview.md	API domain map	Improves API discovery
DONE	installation/docs-publisher.md	DocsPublisher runtime topology	Clarifies deployment model

Execution notes¶

Start with Priority 1 pages and keep each page to one primary diagram plus one optional sequence diagram.
Reuse the existing Mermaid init theme pattern used in architecture docs for visual consistency.
Validate each batch with markdown diagnostics and link checks after edits.