docs.html html
82 lines 4.9 KB
Raw
sha256:ff22b6a82a08c117176c3e2603264a0e49fe8204ce57c3cefe7f5b165a8634f8 docs: recenter public story on governance loop Human 6 days ago
1 <!DOCTYPE html>
2 <html lang="en" data-theme="dark">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1">
6 <meta name="description" content="Overseer Kit docs — review a frozen plan, build it in phases, verify the result, and hand over the truth.">
7 <title>Docs — Overseer Kit</title>
8 <link rel="icon" href="assets/favicon.ico" sizes="any">
9 <link rel="icon" type="image/png" href="assets/favicon-32.png" sizes="32x32">
10 <link rel="apple-touch-icon" href="assets/apple-touch-icon.png">
11 <link rel="stylesheet" href="assets/style.css">
12 <script src="assets/theme.js" defer></script>
13 </head>
14 <body>
15 <header class="site-header">
16 <nav>
17 <a class="brand" href="index.html" aria-label="Overseer Kit home">
18 <span class="logo-mark" aria-hidden="true">OK</span>
19 <span class="brand-name">Overseer Kit</span>
20 </a>
21 <div class="nav-links">
22 <a href="index.html#how-it-works">How it works</a>
23 <a href="index.html#console-access">Get started</a>
24 <a href="scenarios/index.html">Scenarios</a>
25 <a href="docs.html" aria-current="page">Docs</a>
26 <button type="button" id="theme-toggle" class="theme-toggle" aria-label="Switch to light mode" title="Light / dark">
27 <span class="theme-icon theme-icon-moon" aria-hidden="true">☾</span>
28 <span class="theme-icon theme-icon-sun" aria-hidden="true">☀</span>
29 </button>
30 </div>
31 </nav>
32 </header>
33
34 <main>
35 <h1>Docs</h1>
36 <p class="lead">Start with the honesty loop: freeze and challenge the plan, build accepted phases, review the implementation, then hand over what is actually true.</p>
37
38 <section>
39 <h2>On this site</h2>
40 <ul class="compact">
41 <li><a href="index.html#how-it-works">How it works</a> — plan review, phased build, completion review, and truthful handover</li>
42 <li><a href="index.html#structure">Structure</a> — ROADMAP/HANDOVER lanes, safety layers, and optional repository authority</li>
43 <li><a href="index.html#console-access">Get started</a> — <code>install</code>, freeze the plan, build, verify, and hand over</li>
44 <li><a href="scenarios/index.html">Scenario gallery</a> — the same governance loop applied to different kinds of work</li>
45 </ul>
46 </section>
47
48 <section>
49 <h2>Start the workflow</h2>
50 <ol>
51 <li>Download the reviewed v1.0.0-rc.1 prerelease installation and rollback guide from GitHub Releases.</li>
52 <li>From the kit: <code>./cli/ok -C &quot;$PROJECT_ROOT&quot; init --vcs git --repo-name PROJECT-NAME --lane product --model &quot;MODEL LABEL&quot;</code></li>
53 <li>Write bounded phases in ROADMAP, freeze the outputs and acceptance evidence, then resolve findings from a separate agent chat or human reviewer before build.</li>
54 <li>Build the accepted phases, run project-owned checks, and have a separate reviewer compare the result with the freeze before DONE. Update ROADMAP and HANDOVER to match reality, then use <code>next-write</code> to carry the reviewed next task forward.</li>
55 </ol>
56 <p>The reviews are independent actions performed by your chosen agent session or human reviewer. The current <a href="https://github.com/aaronrene/overseer-kit/releases/tag/v1.0.0-rc.1">reviewed prerelease</a> does not run agents or decide that a plan or build is correct; its public CLI preserves repository-bound continuity between those actions.</p>
57 </section>
58
59 <section>
60 <h2>GitHub docs</h2>
61 <p>Current guides, living-document templates, and the full documentation tree live in the repository. Repository, revision, and NEXT checks support the governance loop; they are not its purpose. This public website does not run Overseer, execute prompts, perform reviews, or access a repository.</p>
62 <ul class="compact">
63 <li><a href="https://github.com/aaronrene/overseer-kit">Repository home</a></li>
64 <li><a href="https://github.com/aaronrene/overseer-kit/blob/main/README.md">README</a></li>
65 <li><a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/README.md">Docs index</a></li>
66 <li><a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/GIT-ONLY-QUICKSTART.md">Git-only quickstart</a></li>
67 <li><a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/MIGRATE-EXISTING-REPO.md">Muse adoption and rollback</a></li>
68 <li><a href="https://github.com/aaronrene/overseer-kit/blob/main/MUSE-BRIDGE-WORKFLOW.md">Controlled GitHub mirror workflow</a></li>
69 </ul>
70 </section>
71 </main>
72
73 <footer class="site-footer">
74 <p>
75 <a href="https://github.com/aaronrene/overseer-kit/blob/main/LICENSE">MIT open source</a>
76 · <a href="https://github.com/aaronrene/overseer-kit/blob/main/SECURITY.md">Security</a>
77 · <a href="index.html">Home</a>
78 </p>
79 <p class="footer-tagline">🆗 Overseer Kit — Honesty for Agents.</p>
80 </footer>
81 </body>
82 </html>
File History 1 commit
sha256:ff22b6a82a08c117176c3e2603264a0e49fe8204ce57c3cefe7f5b165a8634f8 docs: recenter public story on governance loop Human 6 days ago