aaronrene / overseer-kit public
docs.html html
33 lines 6.0 KB
Raw
sha256:c079680aa72b38cf20f7891daeadbb28f6ec71301dff7c1973565401e6f23a34 docs: align public documentation and website with bounded v1 Human minor ⚠ breaking 7 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="Current installation, seven public commands, and the init → status → next → next-write flow.">
7 <title>Docs — Overseer Kit</title>
8 <link rel="icon" href="assets/favicon.ico" sizes="any">
9 <link rel="stylesheet" href="assets/style.css">
10 <script src="assets/theme.js" defer></script>
11 </head>
12 <body>
13 <a class="skip-link" href="#main">Skip to content</a>
14 <header class="site-header"><nav aria-label="Main navigation">
15 <a class="brand" href="index.html"><span class="logo-mark" aria-hidden="true">OK</span> Overseer Kit</a>
16 <div class="nav-links"><a href="index.html#how-it-works">How it works</a><a href="docs.html">Docs</a><a href="scenarios/">Scenarios</a><button type="button" id="theme-toggle" hidden aria-label="Switch to light mode">Theme</button></div>
17 </nav></header>
18 <main id="main"><section class="page-intro"><p class="eyebrow">DOCUMENTATION</p><h1>Use the CLI that ships.</h1><p class="lead">Initialize → check status → read NEXT → publish a reviewed replacement.</p><p><a href="https://github.com/aaronrene/overseer-kit/releases/tag/v1.0.0-rc.1">v1.0.0-rc.1</a> is a prerelease, not stable and not Latest. Git-only needs no Muse installation or account.</p></section>
19 <section id="current-documents"><h2>Current documents</h2><ul class="resource-list"><li><a href="https://github.com/aaronrene/overseer-kit/blob/main/README.md">Repository README</a> — product scope, setup and daily use</li><li><a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/README.md">Documentation index</a> — current guides and evidence</li><li><a href="https://github.com/aaronrene/overseer-kit/releases/download/v1.0.0-rc.1/INSTALL-AND-ROLLBACK.md">Installation and rollback</a> — verify the five release assets and install source</li><li><a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/GIT-ONLY-QUICKSTART.md">Git-only quickstart</a> — complete repository setup</li><li><a href="https://github.com/aaronrene/overseer-kit/blob/main/MUSE-BRIDGE-WORKFLOW.md">Controlled Muse bridge workflow</a> — optional source and mirror publication</li><li><a href="https://github.com/aaronrene/overseer-kit/releases/tag/v1.0.0-rc.1">rc.1 prerelease</a> — immutable tag and assets</li></ul></section>
20 <section id="flow"><h2>The real flow</h2><p>After following the installation guide, work from the fixed kit source directory. Set <code>PROJECT_ROOT</code> to the absolute path of an existing Git checkout you are authorized to initialize. These commands use the kit’s conventional <code>.venv</code>.</p><pre><code>./cli/ok -C &quot;$PROJECT_ROOT&quot; init --vcs git \
21 --repo-name PROJECT-NAME --lane product --model &#x27;GPT-6 Astra&#x27;
22 &quot;$PROJECT_ROOT/.overseer/bin/ok&quot; status --json
23 &quot;$PROJECT_ROOT/.overseer/bin/ok&quot; next</code></pre><p>Read the actual UUID, branch, revision and <code>next_sha256</code> from status. Write reviewed task text into a regular UTF-8 file inside that repository, then replace the example values below:</p><pre><code>./cli/ok -C &quot;$PROJECT_ROOT&quot; next-write \
24 --repo-id UUID-FROM-STATUS --branch BRANCH-FROM-STATUS \
25 --lane product --model &#x27;GPT-6 Astra&#x27; \
26 --action-id REVIEWED-ACTION --action-kind plan \
27 --base-head REVISION-FROM-STATUS --expect-next NEXT-SHA256-FROM-STATUS \
28 --prompt-file .overseer/local/task.txt</code></pre><p>Read NEXT again after publication. It validates and prints the task; it does not execute it. Use action kind <code>stop</code> when no executable task remains. Hooks stay off by default.</p></section>
29 <section id="commands"><h2>The seven public commands</h2><div class="table-wrap"><table><caption>Bounded-v1 command surface</caption><thead><tr><th scope="col">Command</th><th scope="col">Purpose</th></tr></thead><tbody><tr><th scope="row"><code>status</code></th><td>Read repository identity, runtime, revision and NEXT status.</td></tr><tr><th scope="row"><code>init</code></th><td>Initialize one checkout with its identity and local handoff files.</td></tr><tr><th scope="row"><code>sync</code></th><td>Refresh the bound launcher and runtime pin after an explicit update.</td></tr><tr><th scope="row"><code>adopt</code></th><td>Explicitly change repository authority or restore a preserved configuration.</td></tr><tr><th scope="row"><code>mirror</code></th><td>Prepare and verify a controlled Muse projection; explicitly deliver its GitHub mirror and pull request.</td></tr><tr><th scope="row"><code>next</code></th><td>Validate and print the trusted handoff without running it.</td></tr><tr><th scope="row"><code>next-write</code></th><td>Publish a reviewed handoff with explicit context and the previous NEXT digest.</td></tr></tbody></table></div></section>
30 <section id="history" class="callout"><h2>Current guidance and historical records</h2><p>Older specifications, desktop material, runbooks, templates and editor skills are retained as pre-reset historical records. Their legacy commands are not exposed by the bounded-v1 entrypoint.</p><p>Use the <a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/README.md#historical-material">historical-material index</a> for context, and the current guides above for onboarding.</p><p>PR #87 documentation publication and recovery closeout are complete. GitHub main includes that later documentation; the rc.1 tag and five assets remain unchanged. <a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/ROADMAP.md">Read the completed closeout.</a></p></section></main>
31 <footer><p><strong>One repository. One trusted NEXT.</strong></p><p>This website is informational. It does not run Overseer.</p><p><a href="https://github.com/aaronrene/overseer-kit">GitHub</a> · <a href="https://github.com/aaronrene/overseer-kit/blob/main/LICENSE">MIT license</a> · <a href="https://github.com/aaronrene/overseer-kit/blob/main/SECURITY.md">Security policy</a></p></footer>
32 </body>
33 </html>
File History 1 commit
sha256:c079680aa72b38cf20f7891daeadbb28f6ec71301dff7c1973565401e6f23a34 docs: align public documentation and website with bounded v1 Human minor ⚠ 7 days ago