Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 13 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
71 changes: 50 additions & 21 deletions docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Docs — CodeCartographer</title>
<meta name="description" content="Installation and configuration: drop-in template, Pi-mono extension, MCP server, pipeline selection, and cPanel deployment.">
<meta name="description" content="Installation and configuration: drop-in template, Pi-mono extension, MCP server, pipeline selection, and GitHub Pages deployment.">
<meta name="theme-color" content="#141413">
<link rel="canonical" href="https://codecarto.dev/docs.html">
<link rel="icon" href="logo.svg" type="image/svg+xml">
Expand Down Expand Up @@ -138,6 +138,34 @@ <h2>Slash commands, widgets, and tool gating.</h2>
<p style="color:var(--color-surface);font-weight:500;margin-bottom:4px"><code>/codecarto-usage</code></p>
<p>Show cumulative and per-phase token usage from local phase runs.</p>
</div>
<div>
<p style="color:var(--color-surface);font-weight:500;margin-bottom:4px"><code>/codecarto-open</code></p>
<p>Activate an existing workspace without resetting state.</p>
</div>
<div>
<p style="color:var(--color-surface);font-weight:500;margin-bottom:4px"><code>/codecarto-vision</code></p>
<p>Run a guided product discovery interview for the synthesis pipeline.</p>
</div>
<div>
<p style="color:var(--color-surface);font-weight:500;margin-bottom:4px"><code>/codecarto-switch-pipeline</code></p>
<p>Switch the active pipeline without losing findings or progress.</p>
</div>
<div>
<p style="color:var(--color-surface);font-weight:500;margin-bottom:4px"><code>/codecarto-publish</code></p>
<p>Publish the reimplementation spec to a configured library.</p>
</div>
<div>
<p style="color:var(--color-surface);font-weight:500;margin-bottom:4px"><code>/codecarto-library-init</code></p>
<p>Initialize a library directory with marker and config.</p>
</div>
<div>
<p style="color:var(--color-surface);font-weight:500;margin-bottom:4px"><code>/codecarto-config</code></p>
<p>Show the effective merged configuration.</p>
</div>
<div>
<p style="color:var(--color-surface);font-weight:500;margin-bottom:4px"><code>/codecarto-dashboard</code></p>
<p>Regenerate the dashboard HTML.</p>
</div>
</div>
</div>
</div>
Expand All @@ -147,7 +175,7 @@ <h2>Slash commands, widgets, and tool gating.</h2>
<section class="section">
<div class="container">
<div class="overline">03 · MCP server</div>
<h2>10 tools for any MCP-compatible host.</h2>
<h2>18 tools for any MCP-compatible host.</h2>
<p class="section-sub">
The same core primitives exposed as a Model Context Protocol server. Wire it into Claude Code,
Claude Desktop, or any MCP host. The host runs the LLM, isolates phase sessions, and controls
Expand Down Expand Up @@ -182,11 +210,13 @@ <h2>10 tools for any MCP-compatible host.</h2>
</div>

<p style="margin-top:28px;font-size:15px;color:var(--color-muted)" data-reveal>
The server exposes 10 workflow and library tools: <code>codecarto_init</code>,
<code>codecarto_status</code>, <code>codecarto_next</code>, <code>codecarto_phase</code>,
<code>codecarto_validate</code>, <code>codecarto_complete</code>, and
<code>codecarto_skill</code>, plus <code>codecarto_publish</code>,
<code>codecarto_library_list</code>, and <code>codecarto_library_reindex</code>.
The server exposes 18 workflow and library tools: <code>codecarto_init</code>,
<code>codecarto_status</code>, <code>codecarto_switch_pipeline</code>, <code>codecarto_next</code>,
<code>codecarto_phase</code>, <code>codecarto_validate</code>, <code>codecarto_complete</code>,
<code>codecarto_skill</code>, <code>codecarto_publish</code>, <code>codecarto_library_list</code>,
<code>codecarto_library_reindex</code>, <code>codecarto_library_init</code>,
<code>codecarto_config</code>, <code>codecarto_vision</code>, <code>codecarto_open</code>,
<code>codecarto_usage</code>, <code>codecarto_dashboard</code>, and <code>codecarto_list_skills</code>.
Workflow tools accept an absolute <code>cwd</code> for the target repository; library tools
accept a configured or explicit library path.
</p>
Expand Down Expand Up @@ -228,30 +258,29 @@ <h2>Turn confirmed software maps into a traceable build plan.</h2>
</div>
</section>

<!-- =================== Deploy to cPanel ========== -->
<!-- =================== Deploy with GitHub Pages === -->
<section class="section-dark">
<div class="container">
<div class="overline">05 · Deploy to Namecheap cPanel</div>
<h2>Upload the static bundle and point the domain at it.</h2>
<div class="overline">05 · Deploy with GitHub Pages</div>
<h2>Merge to main and let GitHub Pages publish the site.</h2>
<p class="section-sub">
This site is plain HTML, CSS, and JavaScript. Drop it into <code>public_html</code> on your
cPanel host and it is live.
This site is plain HTML, CSS, and JavaScript. GitHub Pages serves the repository's
<code>main</code> branch from the repository root at <code>codecarto.dev</code>.
</p>

<div class="split">
<div class="deploy-steps" data-reveal>
<ol>
<li>Open Namecheap cPanel and navigate to <strong>File Manager</strong>.</li>
<li>Open the document root for <code>codecarto.dev</code>. For a primary domain this is <code>public_html/</code>. For an addon domain it is the folder assigned as that domain's document root.</li>
<li>Upload the entire contents of this <code>website/</code> folder into that document root.</li>
<li>Confirm <code>index.html</code> sits at the top of the document root.</li>
<li>Enable <strong>AutoSSL</strong> for the domain in cPanel.</li>
<li>Force HTTPS with the included <code>.htaccess</code> file or the cPanel domain settings.</li>
<li>Open a pull request targeting <code>main</code>.</li>
<li>Run <code>npm test</code> against the authoritative CodeCartographer checkout and wait for the pull-request checks to pass.</li>
<li>Merge the pull request. GitHub Pages automatically starts a deployment from <code>main</code> at <code>/(root)</code>.</li>
<li>Confirm the latest build completed in <strong>Settings → Pages</strong>.</li>
<li>Keep <code>CNAME</code> set to <code>codecarto.dev</code>. GitHub Pages manages the approved TLS certificate and enforces HTTPS.</li>
<li>Visit <code>https://codecarto.dev/</code> and hard refresh.</li>
</ol>
</div>
<div class="card-elevated" style="background:rgba(245,239,216,0.06);border:1px solid rgba(245,239,216,0.14);box-shadow:none" data-reveal>
<div class="overline">Files to upload</div>
<div class="overline">Published site files</div>
<ul style="list-style:none;padding:0;display:grid;gap:6px;font-family:var(--font-mono);font-size:13px;color:rgba(245,239,216,0.8);margin:0">
<li>index.html</li>
<li>features.html</li>
Expand All @@ -260,7 +289,7 @@ <h2>Upload the static bundle and point the domain at it.</h2>
<li>site.css</li>
<li>colors_and_type.css</li>
<li>script.js</li>
<li>.htaccess</li>
<li>CNAME</li>
<li>robots.txt</li>
<li>sitemap.xml</li>
</ul>
Expand Down Expand Up @@ -333,7 +362,7 @@ <h4>Package</h4>
</div>
</div>
<div class="site-footer-bottom">
<span>v0.12.0 · MIT License</span>
<span>v0.12.10 · MIT License</span>
<span>codecarto.dev</span>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion features.html
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ <h4>Package</h4>
</div>
</div>
<div class="site-footer-bottom">
<span>v0.12.0 · MIT License</span>
<span>v0.12.10 · MIT License</span>
<span>codecarto.dev</span>
</div>
</footer>
Expand Down
6 changes: 3 additions & 3 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<div class="hero-copy">
<div class="hero-eyebrow">
<span class="dot"></span>
Evidence-backed software cartography · v0.12.0
Evidence-backed software cartography · v0.12.10
</div>
<h1>Understand existing software. <em>Plan what comes next.</em></h1>
<p class="hero-sub">
Expand Down Expand Up @@ -244,7 +244,7 @@ <h3 style="font-size:18px">Pi extension</h3>
</div>
<div class="card">
<h3 style="font-size:18px">MCP server</h3>
<p>10 tools for workflow control and library operations. Wire them into Claude Code, Claude Desktop, or any MCP-compatible host. The host owns phase sessions and compaction; CodeCartographer supplies byte-identical prompts and validation.</p>
<p>18 tools for workflow control and library operations. Wire them into Claude Code, Claude Desktop, or any MCP-compatible host. The host owns phase sessions and compaction; CodeCartographer supplies byte-identical prompts and validation.</p>
</div>
<div class="card">
<h3 style="font-size:18px">Drop-in template</h3>
Expand Down Expand Up @@ -306,7 +306,7 @@ <h4>Package</h4>
</div>
</div>
<div class="site-footer-bottom">
<span>v0.12.0 · MIT License</span>
<span>v0.12.10 · MIT License</span>
<span>codecarto.dev</span>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion showcase.html
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ <h4>Package</h4>
</div>
</div>
<div class="site-footer-bottom">
<span>v0.12.0 · MIT License</span>
<span>v0.12.10 · MIT License</span>
<span>codecarto.dev</span>
</div>
</footer>
Expand Down