Skip to content

The one and only agent harness for complex codebases. Project memory, planning, execution, and verified completion inside Codex.

docs: refresh README and web DESIGN for landing, docs, and commands

YeonGyu-Kim3e121b9147a7
diff --git a/README.md b/README.md
index 5705ad2a..f2b45f0e 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,34 @@
<hr />
+## 🚀 Install
+
+One line. No global install, no `npm i -g`. Always use `bunx`:
+
+```bash
+bunx lazycodex install
+```
+
+This is shorthand for `bunx omo install --platform=codex`. For a fully autonomous, no-TUI setup:
+
+```bash
+bunx lazycodex install --no-tui --codex-autonomous
+```
+
+## ⚡ Commands
+
+LazyCodex adds three workflow commands to your OpenCode session:
+
+| Command | Syntax | What it does |
+| --- | --- | --- |
+| `$ulw-loop` | `/ulw-loop "task" [--completion-promise=TEXT] [--strategy=reset\|continue]` | Self-referential loop that runs until Oracle-verified completion. Caps at 500 iterations in ultrawork mode, 100 in normal mode. |
+| `$ulw-plan` | `/ulw-plan "what to build"` | Prometheus strategic planner. Writes a plan to `plans/<slug>.md`. Never writes product code. |
+| `$start-work` | `/start-work [plan-name] [--worktree <path>]` | Executes a plan until every checkbox is done. Prints **ORCHESTRATION COMPLETE**. |
+
+Full documentation lives at [lazycodex.ai/docs](https://lazycodex.ai/docs).
+
+<hr />
+
## 💤 What is this?
**LazyCodex** is the **lazy way** to get [OmO (oh-my-openagent)](https://github.com/code-yeongyu/oh-my-openagent) up and running.
diff --git a/packages/web/DESIGN.md b/packages/web/DESIGN.md
index 0d75556d..4b090c84 100644
--- a/packages/web/DESIGN.md
+++ b/packages/web/DESIGN.md
@@ -34,3 +34,81 @@
- **Sheen**: Screen blend mode, diagonal linear gradients with blur.
- **Pools**: Screen blend mode, subtle violet pools at bottom-left and top-right.
- **Grain**: Overlay blend mode, SVG fractal noise.
+
+## 6. Co-brand layer (Sisyphus Labs)
+
+Sisyphus Labs colors are used as accents across the landing page while the navy Codex card stays the hero centerpiece.
+
+- **Cyan**: `#87F0F2`
+- **Teal**: `#008385`
+- **Mint**: `#B3FEFF`
+- **Glow**: `#ABF5F7`
+- **Night**: `#0A0A0A`
+- **Panel**: `#0E1115`
+
+Where they appear:
+- GitHub stars pill in the sticky header
+- Command-card accents (borders, icons, hover states)
+- The `ultrawork` keyword glow inside the hero tagline
+- CTA and link accents (hover underlines, button fills)
+- Footer co-brand strip
+
+## 7. Landing IA
+
+The landing page is a single scrollable document with the following sections, top to bottom:
+
+1. **Sticky header**
+ - Boulder mark (small, 32px) + wordmark
+ - GitHub stars pill (Sisyphus Labs cyan accent)
+ - "Docs" link
+ - "by Sisyphus Labs" co-brand
+
+2. **Hero navy card**
+ - Eyebrow: "LAZYCODEX"
+ - H1 wordmark
+ - Tagline: "You don't need to ultrathink. / Just prompt {your prompt} ultrawork."
+ - The `{your prompt}` placeholder uses Geist Mono and pulses subtly
+
+3. **Install block**
+ - Copyable bash snippet: `bunx lazycodex install`
+ - One-line note: "No global install. Always `bunx`."
+ - Secondary line for the autonomous variant: `bunx lazycodex install --no-tui --codex-autonomous`
+
+4. **Three command cards**
+ - `$ulw-loop` — self-referential loop
+ - `$ulw-plan` — Prometheus planner
+ - `$start-work` — plan executor
+ - Each card has a monospace command header, a one-line description, and a syntax example
+
+5. **Ultrawork explainer**
+ - Short paragraph on what `ultrawork` means (OmO discipline mode, parallel agents, auto-verification)
+ - Link to the docs deep-dive
+
+6. **Docs CTA**
+ - Large button: "Read the docs"
+ - Secondary link: "View on GitHub"
+
+7. **Footer**
+ - Sisyphus Labs co-brand strip (night + panel colors)
+ - Links: GitHub, OmO, sisyphuslabs.ai
+ - MIT license note
+
+## 8. Docs system
+
+- **Markdown source**: `content/docs/*.md`
+- **Build-time compilation**: `marked` parses each `.md` file into HTML strings and TypeScript exports at `lib/docs-content.generated.ts`
+- **Static navigation**: `lib/docs-sections.ts` defines the section order, slugs, and titles; no runtime file-system access
+- **Server rendering**: Each docs page is server-rendered (SSR) so the content is readable with JavaScript disabled
+- **Client docs-shell**: A lean React layer adds:
+ - Search (filters sections by title and heading text)
+ - Scroll-spy (highlights the current heading in the nav)
+ - Mobile menu (collapsible section list)
+
+## 9. Image pipeline
+
+- **Boulder art**: Generated via `imagegen` on a chroma background, keyed to alpha so it composites cleanly on the navy canvas without a visible bounding box
+- **Delivery format**: Served as AVIF / WebP / PNG via a `<picture>` element using the `BrandImage` component
+- **Dimensions**: Explicit `width` and `height` attributes on every image to prevent CLS
+- **Favicon / app-icon**: The rock boulder is reused as the site favicon and Apple touch icon:
+ - `app/icon.png`
+ - `app/apple-icon.png`