index.html
html
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="A small local CLI for one trusted NEXT handoff per repository. Git-only is permanently supported. v1.0.0-rc.1 is a prerelease."> |
| 7 | <title>One trusted NEXT — 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"> |
| 19 | <section id="hero" class="hero"><div><p class="eyebrow">LOCAL CLI · BOUNDED V1</p><h1>Pick up the right task.<br><span>In the right repository.</span></h1><p class="lead">One trusted NEXT handoff for each repository. Check where you are, read the task, and replace it deliberately when the work changes.</p><p class="muted">For people working across projects, branches and AI sessions.</p><div class="actions"><a class="button primary" id="cta-release" href="https://github.com/aaronrene/overseer-kit/releases/tag/v1.0.0-rc.1">Get v1.0.0-rc.1 <span>Prerelease ↗</span></a><a class="button" href="https://github.com/aaronrene/overseer-kit/releases/download/v1.0.0-rc.1/INSTALL-AND-ROLLBACK.md">Installation & rollback ↗</a></div><p><a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/GIT-ONLY-QUICKSTART.md">Git-only quickstart</a> · <a href="https://github.com/aaronrene/overseer-kit">View on GitHub</a></p><p class="release-note">rc.1 is a prerelease, not a stable release and not Latest.</p></div> |
| 20 | <aside class="terminal" aria-label="Daily use in an initialized repository"><div class="terminal-bar"><span aria-hidden="true">● ● ●</span> A deliberate handoff</div><pre><code>./.overseer/bin/ok status |
| 21 | ./.overseer/bin/ok next</code></pre><div class="terminal-note"><span class="signal" aria-hidden="true"></span><p>Repository → branch → revision → NEXT</p></div><p>Overseer validates the context before printing the prompt. You decide what to do with it.</p></aside></section> |
| 22 | <section id="context"><p class="eyebrow">CONTEXT BEFORE ACTION</p><h2>A copied prompt should not become the wrong project’s task.</h2><div class="grid three"><article><h3>Know the repository</h3><p>A persistent repository identity and exact physical-folder binding distinguish similar checkouts.</p></article><article><h3>Know the moment</h3><p>Branch and authoritative revision checks catch a stale handoff when the work has moved on.</p></article><article><h3>Know what changed</h3><p>Lane, model label, action identity and prompt checks protect the handoff. A replacement requires the previous NEXT digest.</p></article></div><p class="muted">The model label is declared context; Overseer does not verify which AI model is running or judge the task’s quality.</p></section> |
| 23 | <section id="how-it-works"><p class="eyebrow">THE EVERYDAY FLOW</p><h2>Four commands. An explicit handoff.</h2><ol class="steps"> |
| 24 | <li><span class="step-number">01</span><h3>Initialize a repository</h3><p>Choose Git or Muse explicitly. Bind the checkout’s physical folder and repository identity.</p><code>init</code></li> |
| 25 | <li><span class="step-number">02</span><h3>Check the context</h3><p>Read the repository, branch, revision, lane, model label and NEXT status.</p><code>status</code></li> |
| 26 | <li><span class="step-number">03</span><h3>Read the trusted task</h3><p>Validate the handoff before copying it into your work session. Overseer does not run it.</p><code>next</code></li> |
| 27 | <li><span class="step-number">04</span><h3>Publish a reviewed replacement</h3><p>Choose the next task yourself. Supply its context and the previous NEXT digest to publish it.</p><code>next-write</code></li> |
| 28 | </ol><p>Start with the <a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/GIT-ONLY-QUICKSTART.md">Git-only quickstart</a> for complete commands and the values to supply.</p></section> |
| 29 | <section id="modes"><p class="eyebrow">YOUR REPOSITORY, YOUR CHOICE</p><h2>Keep Git. Choose Muse when you need it.</h2><div class="grid three"><article><h3>Git-only</h3><p>Permanently supported. No Muse installation, no Muse account and no migration requirement.</p></article><article><h3>Muse-only</h3><p>Explicitly initialize or adopt Muse authority for a repository. Freshness follows its Muse branch and revision.</p></article><article><h3>Muse + GitHub mirror</h3><p>Prepare and verify a controlled projection. Explicit delivery can push the verified mirror and create its pull request; it never merges it.</p></article></div><p><a href="https://github.com/aaronrene/overseer-kit/blob/main/MUSE-BRIDGE-WORKFLOW.md">Read the controlled bridge workflow →</a></p></section> |
| 30 | <section id="boundaries" class="callout"><h2>Small by design.</h2><p>A local command-line tool. No hosted service, desktop product, background process, telemetry, automatic updater, registry or OCI system.</p><p>Overseer does not run prompts, choose the next task, merge automatically, release automatically or deploy automatically. Hooks are optional and off by default.</p><p>It protects against stale context and ordinary mistakes on a trusted host. It is not a boundary against a malicious administrator.</p></section> |
| 31 | <section id="start"><p class="eyebrow">START WITH ONE REPOSITORY</p><h2>A handoff you can inspect.</h2><p>Install the checksum-verified prerelease source at a fixed physical path, then initialize a repository you are authorized to manage.</p><div class="actions"><a class="button primary" href="https://github.com/aaronrene/overseer-kit/blob/main/docs/GIT-ONLY-QUICKSTART.md">Open the Git-only quickstart →</a><a class="button" href="docs.html">Explore the seven commands</a></div><p><a href="scenarios/">See example scenarios →</a></p></section> |
| 32 | </main> |
| 33 | <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> |
| 34 | </body> |
| 35 | </html> |
File History
1 commit
sha256:c079680aa72b38cf20f7891daeadbb28f6ec71301dff7c1973565401e6f23a34
docs: align public documentation and website with bounded v1
Human
minor
⚠
7 days ago