109 lines
3.5 KiB
HTML
109 lines
3.5 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
|
<title>Update Outline — Roject</title>
|
||
|
|
<link rel="stylesheet" href="../../_assets_/styles.css">
|
||
|
|
<link rel="stylesheet" href="../../_assets_/nav.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="page">
|
||
|
|
|
||
|
|
<header>
|
||
|
|
<h1>Update Outline</h1>
|
||
|
|
<p class="subtitle">When and how to keep the project outline current.</p>
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<h2>Summary</h2>
|
||
|
|
|
||
|
|
<div class="card">
|
||
|
|
<p>
|
||
|
|
The outline at <code>workspace/outline/index.html</code> is the single source of
|
||
|
|
truth for what the project is, what exists, and what still needs work. Keep it
|
||
|
|
current whenever the project's scope, structure, or conventions change. Also keep
|
||
|
|
<code>CLAUDE.md</code> in sync — it should only point to the outline, never
|
||
|
|
duplicate content.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<h2>When to Update</h2>
|
||
|
|
|
||
|
|
<div class="decision">
|
||
|
|
<strong>After adding or completing a feature</strong>
|
||
|
|
<p>
|
||
|
|
Move items between <em>What exists now</em> and <em>What still needs work</em>
|
||
|
|
to reflect the current state of the application.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="decision">
|
||
|
|
<strong>After structural changes</strong>
|
||
|
|
<p>
|
||
|
|
Update the Technical Implementation cards when tsconfig setup, build commands,
|
||
|
|
directory layout, or major architectural patterns change.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="decision">
|
||
|
|
<strong>After adding guides or actions</strong>
|
||
|
|
<p>
|
||
|
|
Add links to new guides or actions pages in the outline's reference section so
|
||
|
|
they are discoverable. Also update <code>workspace/index.html</code> if a new
|
||
|
|
top-level section (guides, actions) was added.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<h2>Steps</h2>
|
||
|
|
|
||
|
|
<div class="card">
|
||
|
|
<h3>Step 1 — Update outline/index.html</h3>
|
||
|
|
<p>
|
||
|
|
Edit <code>workspace/outline/index.html</code>. At minimum update:
|
||
|
|
</p>
|
||
|
|
<ul>
|
||
|
|
<li>The <em>What exists now</em> card</li>
|
||
|
|
<li>The <em>What still needs work</em> card</li>
|
||
|
|
<li>Any Technical Implementation card whose content changed</li>
|
||
|
|
</ul>
|
||
|
|
<p style="margin-top:0.75rem">
|
||
|
|
Always use correct links — never omit <code>index.html</code> from hrefs.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="card">
|
||
|
|
<h3>Step 2 — Check CLAUDE.md</h3>
|
||
|
|
<p>
|
||
|
|
Open <code>CLAUDE.md</code> at the project root and verify it still just points
|
||
|
|
to the outline. If it has drifted and contains duplicated or stale content,
|
||
|
|
trim it back so it only references <code>workspace/outline/index.html</code>.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="card">
|
||
|
|
<h3>Step 3 — Update nav-data.js if pages were added</h3>
|
||
|
|
<p>
|
||
|
|
If new guide or action pages were created, add them to
|
||
|
|
<code>workspace/_assets_/nav-data.js</code> under the correct parent node.
|
||
|
|
Always use workspace-relative paths.
|
||
|
|
</p>
|
||
|
|
<pre><code>{ title: 'My New Guide', path: 'guides/my-new-guide/index.html' }</code></pre>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<footer>
|
||
|
|
Roject — update outline
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<script>var NAV_ROOT = '../../';</script>
|
||
|
|
<script src="../../_assets_/nav-data.js"></script>
|
||
|
|
<script src="../../_assets_/nav.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|