SuperAPI AI Directory

migrate-to-cloudcannon

General & other

View repository

Updated 10-15 19:50

About this skill

Migrating to CloudCannon

This skill orchestrates a full migration of an existing SSG site to CloudCannon. It coordinates five phases, delegating domain-specific work to standalone skills that can also be used independently.

Model recommendation: Migrations involve multi-file architectural decisions across five phases. Use a high-reasoning model (not a fast/lightweight one) for best results.

When to use

  • An existing SSG site needs to work with CloudCannon end to end
  • A site template needs to be made CloudCannon-compatible
  • A site is being generated as part of the task (e.g. from WordPress) and should land CloudCannon-ready

When not to use

Contents

File Covers
SKILL.md (this file) The five phases, handoff readiness, naming conventions, common mistakes
astro/overview.md Start here for Astro — the per-phase guides
chunking.md Splitting a large migration across several conversations
handoff.md Closing with the user — who tests what, and what to ask back
reading-order.md Which docs to read in which phase, and when to skip them
scripts/README.md Automation scripts for the deterministic steps

Supported SSGs

SSG Guide
Astro astro/overview.md

Chaining with upstream skills

If the site is being generated as part of this task (e.g. converting from WordPress), read astro/cc-friendly-conventions.md before scaffolding — it covers the structural choices that make the migration smooth. Once scaffolded, return here and run the migration phases.

Step 1: Detect the SSG

Run from the project root:

npx @cloudcannon/cli configure detect-ssg

Use the detected SSG to pick the correct guide above.

Migration phases

Each SSG guide walks through these in order. Phases that delegate to standalone skills are marked below.

  1. Audit — Analyze content structure, components, routing, and build pipeline before changing anything.
  2. Configuration — Generate and customize CloudCannon config files.
    • Read the cloudcannon-configuration skill.
    • If the site uses MDX components or inline HTML in content, also read the cloudcannon-snippets skill.
  3. Content — Restructure content files if needed so they're CMS-friendly.
  4. Visual editing — Add editable regions for CloudCannon's Visual Editor.
    • Read the cloudcannon-visual-editing skill.
  5. Build and test — Validate the migration end-to-end.

Not every site needs all phases. Small sites may skip Phase 3 if content is already well-structured. Phase 4 is optional but high-value.

Per-phase workflow

For each phase, in order:

  1. Read the phase doc end-to-end before touching any files.
  2. Track one task per checklist item in that phase doc, using the host's task/todo tool. If there is none, keep the checklist in the phase's migration note and tick items off there. Set the task in_progress before starting it; mark completed only when the checklist item is satisfied. Do not batch-complete tasks at the end of the phase.
  3. Do the work — small, mechanical cross-phase fixes (adding a missing field, normalizing a value) are fine in any phase; structural changes (moving files, reorganizing collections, altering rendering) wait for their proper phase.
  4. Write .cloudcannon/migration/<phase>.md documenting decisions, findings, and anything the user should review.
  5. Check the handoff readiness row below. If it's met, the phase is safe to hand off to a fresh conversation. Whether you actually open a fresh conversation is a judgment call (see chunking.md) — within one conversation, just continue.

Why: checklists catch things agents otherwise skim past — data collections missing from collections_config, data_config entries missing for referenced data files, blog/detail page editables skipped while focusing on page-builder blocks, arrays not linked to structures. Per-item tracking makes the skim visible.

Phase handoff readiness

These rows define what must be true for a phase to be safely picked up by a fresh conversation. They are not walls inside one conversation — cross-phase fixes (per step 3 above) are still fine. They exist so a chunked migration's later runs have a clean starting point.

After phase Ready for handoff when…
1. Audit .cloudcannon/migration/audit.md exists, contains the census table, and lists every collection + every page route. Sectioning thresholds (below) have been evaluated; if tripped, .cloudcannon/migration/plan.md exists.
2. Configuration cloudcannon.config.yml validates against the published JSON schema (no IDE red squigglies). Every collection in the audit has a collections_config entry; every referenced data file has a data_config entry. .cloudcannon/migration/configuration.md written.
3. Content All structural content changes from Phase 2 are reflected in the files. npm run build (or project equivalent) succeeds. .cloudcannon/migration/content.md written.
4. Visual editing Every section flagged in the audit census as "needs editable region" has been wired or has a documented justification for not being wired. registerComponents.ts registers every component used inside a wrapped section. .cloudcannon/migration/visual-editing.md written.
5. Build and test Production build succeeds locally. User has run their CloudCannon-side verification (preview, inline edit, save-to-git). .cloudcannon/migration/build.md written.

Scripts

Deterministic migration steps are automated as scripts in scripts/. Run these before or during the relevant phase.

Migration notes

All written to .cloudcannon/migration/ (under .cloudcannon/ so the CLI doesn't detect the folder as a collection): one file per phase (audit.md, configuration.md, content.md, visual-editing.md, build.md), plus plan.md if the migration is sectioned. See the per-phase workflow above for the gates that consume each file.

Naming conventions

Follow existing project conventions when present. Otherwise:

  • kebab-case for files
  • camelCase for JavaScript and JSON
  • Markdown frontmatter and YAML: match existing component prop names so frontmatter keys pass through without translation
  • New fields with no existing convention: prefer snake_case

Cross-references for known pitfalls

For specific architectural decisions and config-syntax mistakes, see:

Topic Owner
Classifying static pages (source-editable vs page-builder vs collection) astro/audit.md § Classifying static pages
home.md vs index.md, collection-of-one astro/page-building.md § Common mistakes
Shared UI (CTA banners, footers, share blocks) astro/cc-friendly-conventions.md § Shared-UI treatment table
Multi-schema collections (pages with z.union) ../cloudcannon-configuration/astro/configuration.md § Schemas
Config-syntax hallucinations (wrong keys/types) cloudcannon-configuration § Common invalid keys
Unstyled markdown body despite prose classes (Tailwind typography) astro/build.md § Build verification checklist

Common mistakes

Excuse Reality
"This site is simple enough to skip the audit" The audit catches structural issues early. Skipping it means discovering problems mid-configuration.
"I'll do the checklist at the end" Read checklists BEFORE starting each phase. They tell you what to aim for.
"Content restructuring can wait" If a missing field blocks configuration, add it now. Phases are sequential, not siloed.
"Visual editing is optional so I'll skip it" It's the highest-value phase for editors. Only skip if the user explicitly says so.
"The build passes so we're done" A passing build doesn't mean the editor works. The user must verify in CloudCannon.
"I'll call the homepage file home.md — it's more descriptive" CloudCannon resolves the URL from the slug; home.md with url: "/[slug]/" → /home/. Use index.md so Astro collapses the slug to /.
"It's hardcoded, so it's developer-only" If an editor can see it on the page, they must be able to edit it. The mechanism depends on the page: shared UI (CTA banners, footers, share blocks, author cards) → data file; unique-layout pages with 2+ sections → page-builder pages collection entry; long-form prose page → fixed-schema collection with markdown body. data-editable="source" is for long-form prose only — not the default for any one-off string. See astro/cc-friendly-conventions.md § Shared-UI treatment table and astro/page-building.md § When to reach for page builder.
"This page is unique so it should be source-editable" Unique-layout pages with 2+ sections belong in a pages collection with a page-builder schema. Source-editable is for long-form prose only. See astro/audit.md § Classifying static pages.
"I'll make a single-entry homepage collection" Use one pages collection with index.md as one entry. Add our-team.md, about.md, etc. as more entries. CloudCannon collections support multiple schemas per collection — both via schemas: config and via Zod z.union in Astro content config. See ../cloudcannon-configuration/astro/configuration.md § Schemas.
"Page builder is overkill for these few pages" Page builder is the default for any site with more than one unique-layout page. The cost is a [...slug].astro catch-all + a BlockRenderer — both are mechanical. The benefit is editors can add new pages without engineering.