Documentation Index¶
Central documentation hub for Hybrid Cloud Works. All filenames follow the convention
<domain>-<topic>[-<detail>].md, lowercase kebab-case.
The docs here are the current living references for the active site, admin tooling, Firebase
architecture, security, testing, and platform roadmap. Older or superseded material is archived
under ../archive/docs/ (historical target unavailable).
Getting Started¶
- Project Status (Current) - latest project status.
- Admin Portal Guide - admin CMS guide.
- Admin Portal Upgrade - May 2026 sidebar/AI Engine/Plaud/Publer upgrade notes.
- Admin API Patterns - API decision matrix for admin mutations.
- Admin Operations Runbook - production gates, deploy and smoke steps.
- Admin Verification Workflows - verification tiers for admin changes.
Frontend & Design¶
- Frontend Firebase Architecture - React + Firebase overview.
- Frontend Pages Guide - provider page matrix + Firestore-driven architecture.
- Frontend Component Library - animation, accessibility, and performance components.
- Frontend Theming Guide - light/dark contract, contrast, CSS vars.
- Frontend Routing Guide - routing factory + standalone tools.
- Frontend UI/UX Reference - UI/UX patterns by provider.
- Frontend News System - RSS curation, scoring algorithm, live timeline.
- Design Typography System - fonts and provider brands.
- Design Visual Validation - pre-deployment visual QA checklist.
- Mobile First Guide - responsive redesign guide.
- Performance Optimization - frontend optimization notes.
Architecture & Backend¶
- System Overview - system diagram + component hierarchy.
- Folder Structure - top-level folder + root-file reference map.
- Infrastructure Complete - frontend + serverless blueprint.
- API Mapping - active API integration journal.
- AI Abstraction - provider-agnostic AI router.
- Agents Architecture - agents reference.
- Labs Platform Guide - Hostinger VPS labs backend and pull-based runner.
Database & Storage¶
- Firestore Collections - schema reference + Rowy/BuildShip UI config.
- Firestore Population - initial data seeding.
- Model Roadmap - P3 roadmap to converge
content. - Rollback Checklist - fast rollback sequence and schema-lock contract.
AI & Automation¶
- AI Stack Report - cost-first AI stack baseline.
- AI Integration Inventory - reference catalog of all AI call sites.
- AI Recommendations - Stage 6 recommendations.
- Firebase & GCP Cost Inventory - Firebase cost audit.
- ContentForge Capability - capability assessment.
- Streamlined Content Creator - Gemini 2.0 + Imagen-4 article pipeline.
- Curated Article Fallback Strategy - og:image-first cover strategy.
- Scraping Upgrade - scraping fallback envelope, telemetry, optional headless.
- Stage 1 Features - publishedDate extraction, cloudProvider override, skipImageGeneration.
Security & Secrets¶
- Security Secrets Guide - 3-tier secrets architecture.
- Security Backend Audit - backend PII security audit.
- Security Pipeline Audit - pipeline PII security audit.
- Security Firebase Auth Guide - Firebase Auth + custom domain setup.
- Terraform Notion Secrets Audit - Terraform vs Notion audit.
- Notion SOPS - Notion-to-SOPS sync tool.
Pipelines & DevOps¶
- CI/CD Workflows - workflows reference.
- Deployment Guide - two-tier strategy + GitOps.
- Handover Guide - handover steps and Firebase deployment steps.
- AI Deployment - AI deployment runbook.
- Dependencies Manifest - dependency audit.
- Dependency Notes - npm overrides, CVE rationale, vulnerabilities.
- Terraform Cloud Setup - Terraform Cloud workspace config.
Testing & Quality¶
- Quality Guide - ContentForge + frontend testing.
- Accessibility Compliance Audit - WCAG 2.1 AA audit.
- Verification Content Creator - editor/blog/architecture verification.
- Lighthouse Guide - local Lighthouse audit setup.
Planning & Process¶
- Content Architecture - client-side data fetching architecture.
- Ownership Matrix - P0-P3 ownership map.
- Personas Reference - AI persona definitions.
- Commit Standards - Conventional Commits via commitlint.
- Documentation Standards - KCS v6 standards.
- Issues Tracking - issue template collection.
- Issue Templates - combined issue templates reference.
- Repo Cleanup - cleanup policy + protected docs.
Integrations¶
- External Data Sources - Sessionize, Nominatim.
- BuildShip Firestore - Buildship low-code setup.
- Vendor News Feeds - RSS + Firecrawl + AI enrichment.
- Speaking Events Workflow - BuildShip event-image workflow.
- Stitch Integration - design-to-code mapping.
- Bulk Processing - cost-optimized bulk URL processing.
- Notion MCP Setup - Notion MCP server setup.
Live Smoke Tests¶
live-smoke-tests/-SMOKE-TEST.md+SMOKE-TEST-SIGNOFF.md.
Reports¶
reports/(historical target unavailable) - generated reports.
Archive¶
Files no longer current are moved to ../archive/docs/ (historical target unavailable). See
CHANGELOG.md for the full list and rationale.
Last updated: June 12, 2026. Naming convention: lowercase kebab-case
<domain>-<topic>[-<detail>].md.