diff --git a/README.md b/README.md index c8e3391..9e65bf5 100644 --- a/README.md +++ b/README.md @@ -6,29 +6,26 @@ Static marketing site for `codecarto.dev`. Built on the Hearth UI design templat - `index.html` — overview and landing page - `features.html` — pipeline variants, evidence classification, phase-gating, output artifacts -- `docs.html` — installation (drop-in, Pi-mono, MCP), configuration, cPanel deployment +- `docs.html` — installation (drop-in, Pi-mono, MCP), configuration, GitHub Pages deployment - `showcase.html` — example outputs, defect scan passes, model compatibility, use cases - `site.css` — marketing site styles (imports `colors_and_type.css`) - `colors_and_type.css` — canonical design tokens (palette, typography, spacing, shadows) - `logo.svg` — CodeCartographer map/matrix brand icon and favicon - `script.js` — pipeline switcher, copy buttons, scroll reveals -- `.htaccess` — Apache config (HTTPS redirect, security headers) +- `CNAME` — GitHub Pages custom-domain configuration for `codecarto.dev` - `robots.txt` — crawler guidance - `sitemap.xml` — sitemap for the live domain -- `LAUNCH_CHECKLIST.md` — cPanel launch and post-upload verification checklist - -## Deploy To Namecheap cPanel - -1. Open Namecheap cPanel for the account serving `codecarto.dev`. -2. Go to File Manager. -3. Open the document root for the domain: - - primary domain: usually `public_html/` - - addon domain: the folder assigned as that domain's document root -4. Upload the contents of this folder into that document root. -5. Confirm `index.html` is at the top of the document root. -6. Enable AutoSSL for `codecarto.dev`. -7. Force HTTPS in the domain settings or with the `.htaccess` file. -8. Visit `https://codecarto.dev/` and hard refresh. + +## Deploy With GitHub Pages + +GitHub Pages publishes the repository's `main` branch from the repository root. + +1. Open a pull request targeting `main`. +2. Run `npm test` against the authoritative CodeCartographer checkout and wait for the pull-request checks to pass. +3. Merge the pull request. GitHub Pages automatically starts a new deployment. +4. Confirm the latest Pages build completed successfully in the repository's **Settings → Pages** view. +5. Keep `CNAME` set to `codecarto.dev`; GitHub Pages manages the approved TLS certificate and enforces HTTPS. +6. Visit `https://codecarto.dev/` and hard refresh. ## Important Link Notes diff --git a/docs.html b/docs.html index c0874bf..e334335 100644 --- a/docs.html +++ b/docs.html @@ -4,7 +4,7 @@ Docs — CodeCartographer - + @@ -228,30 +228,29 @@

Turn confirmed software maps into a traceable build plan.

- +
-
05 · Deploy to Namecheap cPanel
-

Upload the static bundle and point the domain at it.

+
05 · Deploy with GitHub Pages
+

Merge to main and let GitHub Pages publish the site.

- This site is plain HTML, CSS, and JavaScript. Drop it into public_html on your - cPanel host and it is live. + This site is plain HTML, CSS, and JavaScript. GitHub Pages serves the repository's + main branch from the repository root at codecarto.dev.

    -
  1. Open Namecheap cPanel and navigate to File Manager.
  2. -
  3. Open the document root for codecarto.dev. For a primary domain this is public_html/. For an addon domain it is the folder assigned as that domain's document root.
  4. -
  5. Upload the entire contents of this website/ folder into that document root.
  6. -
  7. Confirm index.html sits at the top of the document root.
  8. -
  9. Enable AutoSSL for the domain in cPanel.
  10. -
  11. Force HTTPS with the included .htaccess file or the cPanel domain settings.
  12. +
  13. Open a pull request targeting main.
  14. +
  15. Run npm test against the authoritative CodeCartographer checkout and wait for the pull-request checks to pass.
  16. +
  17. Merge the pull request. GitHub Pages automatically starts a deployment from main at /(root).
  18. +
  19. Confirm the latest build completed in Settings → Pages.
  20. +
  21. Keep CNAME set to codecarto.dev. GitHub Pages manages the approved TLS certificate and enforces HTTPS.
  22. Visit https://codecarto.dev/ and hard refresh.
-
Files to upload
+
Published site files
  • index.html
  • features.html
  • @@ -260,7 +259,7 @@

    Upload the static bundle and point the domain at it.

  • site.css
  • colors_and_type.css
  • script.js
  • -
  • .htaccess
  • +
  • CNAME
  • robots.txt
  • sitemap.xml