aaronrene / overseer-kit public
docs.html html
82 lines 3.9 KB
Raw
sha256:a78e7e5a8740e03315f325d19edeb3aa1b306b3337d04abbaa9a9e0f3bbeb7a1 docs: MuseHub-first before ISR #74 — staging solidify NEXT Human 1 day 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 — get started, living docs, and where to read more.">
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 here on this site. Full operator manuals live in the GitHub repo once you have access.</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> — the honesty loop in plain language</li>
42 <li><a href="index.html#structure">Structure</a> — lanes, version-control options, layers</li>
43 <li><a href="index.html#console-access">Get started</a> — Mac download, <code>ok app</code>, and dev desktop</li>
44 <li><a href="scenarios/index.html">Scenario gallery</a> — software engineering, video, research, and more</li>
45 </ul>
46 </section>
47
48 <section>
49 <h2>Clone / init (short path)</h2>
50 <ol>
51 <li>Clone the kit when you have repo access.</li>
52 <li>From your project: <code>./cli/ok -C . init --regime git-only --non-interactive</code></li>
53 <li>Open the handover living doc and paste the next prompt into your chat.</li>
54 <li>Run <code>./cli/ok governance-sync --dry-run</code> before you end a session.</li>
55 </ol>
56 <p>Primary install for operators: <a href="index.html#path-1">Download Mac console</a> (Apple Silicon).</p>
57 </section>
58
59 <section>
60 <h2>GitHub docs</h2>
61 <p>Deep runbooks and the full docs tree live in the 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/TRACK-Q-DESKTOP-OPERATOR-RUNBOOK.md">Desktop operator runbook</a></li>
68 <li><a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/archive/README.md">Maintainer archive</a> (phase freezes / pilot notes)</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 — portable governance for AI-assisted development.</p>
80 </footer>
81 </body>
82 </html>
File History 1 commit
sha256:a78e7e5a8740e03315f325d19edeb3aa1b306b3337d04abbaa9a9e0f3bbeb7a1 docs: MuseHub-first before ISR #74 — staging solidify NEXT Human 1 day ago