From 49be0c5360a4f8751dfa98015f7fb02b748a7879 Mon Sep 17 00:00:00 2001 From: Kit Langton Date: Sat, 17 Oct 2026 16:56:08 -0700 Subject: [PATCH] docs(www): fix contradictions and typos in the v2 docs (#56588) --- services/www/src/docs/content/agents.mdx | 2 +- services/www/src/docs/content/cli/commands.mdx | 3 ++- services/www/src/docs/content/cli/theme.mdx | 4 ++-- services/www/src/docs/content/cli/web.mdx | 6 +++--- services/www/src/docs/content/config.mdx | 2 +- services/www/src/docs/content/console/go.mdx | 2 +- services/www/src/docs/content/index.mdx | 12 ++++++------ services/www/src/docs/content/themes.mdx | 2 +- 8 files changed, 17 insertions(+), 16 deletions(-) diff --git a/services/www/src/docs/content/agents.mdx b/services/www/src/docs/content/agents.mdx index 1507f5b30e9..90812c31827 100644 --- a/services/www/src/docs/content/agents.mdx +++ b/services/www/src/docs/content/agents.mdx @@ -134,7 +134,7 @@ OpenCode includes these visible agents: | Agent | Mode | Purpose | | --- | --- | --- | -| **Build** (`build`) | `primary` | Default coding agent. Tools are allowed by default; sensitive environment-file reads and access outside the workspace ask for approval. | +| **Build** (`build`) | `primary` | Default coding agent. Tools and access outside the workspace are allowed by default; sensitive environment-file reads ask for approval. | | **Plan** (`plan`) | `primary` | Explores and plans without editing normal project files. It may write OpenCode plan files when asked, and shell commands remain permission-controlled. | | **General** (`general`) | `subagent` | Handles research and multi-step work with broad tool access, but cannot launch more subagents. | | **Explore** (`explore`) | `subagent` | Searches and reads code or web sources without editing files. | diff --git a/services/www/src/docs/content/cli/commands.mdx b/services/www/src/docs/content/cli/commands.mdx index dceac90b4ab..d5d2308d4b5 100644 --- a/services/www/src/docs/content/cli/commands.mdx +++ b/services/www/src/docs/content/cli/commands.mdx @@ -565,7 +565,8 @@ $ opencode upgrade --help ## uninstall -Removes OpenCode and all related files. +Stops background services, removes the global cache, and uninstalls OpenCode. Session data, configuration, and +state are not removed. ```bash $ opencode uninstall diff --git a/services/www/src/docs/content/cli/theme.mdx b/services/www/src/docs/content/cli/theme.mdx index 21748fa6c6f..2617f13700a 100644 --- a/services/www/src/docs/content/cli/theme.mdx +++ b/services/www/src/docs/content/cli/theme.mdx @@ -8,7 +8,7 @@ OpenCode comes with many built-in themes for light and dark modes. Choose one in Press `Ctrl+P`, select **Open settings**, then open **Theme**. The default theme is `opencode`. -You can also set them in your global [CLI settings](/cli/config): +You can also set the theme and mode in your global [CLI settings](/cli/config): ```json title="~/.config/opencode/cli.json" { @@ -174,7 +174,7 @@ Semantic tokens assign colors to UI roles. Components use these roles instead of | Group | Purpose | | --- | --- | -| `text` | Base, muted, faint, action, form-field, status, and feedback text. `faint` defaults to `muted`. | +| `text` | Base, muted, faint, action, form-field, and feedback text. `faint` defaults to `muted`. | | `background` | Base, raised surfaces, actions, form fields, and feedback fills. | | `border`, `scrollbar` | Border and scrollbar colors. | | `diff` | Added, removed, context, highlight, and line-number colors. | diff --git a/services/www/src/docs/content/cli/web.mdx b/services/www/src/docs/content/cli/web.mdx index 3c7326bbfcc..da553409204 100644 --- a/services/www/src/docs/content/cli/web.mdx +++ b/services/www/src/docs/content/cli/web.mdx @@ -3,7 +3,7 @@ title: "Web" description: "Run OpenCode in the browser." --- -OpenCode ships with a web ui that is served from the same server that powers the +OpenCode ships with a web UI that is served from the same server that powers the TUI. It's available by default and password protected. ## Access @@ -19,7 +19,7 @@ $ opencode pair ``` Opening a link in a browser signs it in with a session cookie and loads the web -ui. Scanning the QR code from the OpenCode app, or pasting the link into its +UI. Scanning the QR code from the OpenCode app, or pasting the link into its server address field, connects the app the same way. Sessions last 30 days; changing the server password signs every session out. @@ -95,7 +95,7 @@ $ opencode service set cors https://app.example.com,https://other.example.com $ opencode service set env OPENCODE_LOG_LEVEL DEBUG ``` -Changing a setting stops the background server. To apply the new config +Changing a setting stops the background server. Start it again to apply the new config: ```bash $ opencode service start diff --git a/services/www/src/docs/content/config.mdx b/services/www/src/docs/content/config.mdx index 4f79c93f870..108a8ef9763 100644 --- a/services/www/src/docs/content/config.mdx +++ b/services/www/src/docs/content/config.mdx @@ -386,7 +386,7 @@ automatic and manual requests with a provider or model policy: A model setting overrides the provider setting. Automatic compaction uses the selected model's usable input budget. Provider checkpoints keep recent user messages within the same -`compaction.tokens` budget that local summaries use for their retained tail. +`compaction.keep.tokens` budget that local summaries use for their retained tail. Top-level `compaction.auto: false` disables new automatic compaction without discarding installed checkpoints. See the [compaction guide](/compaction) for budgeting and overflow recovery. diff --git a/services/www/src/docs/content/console/go.mdx b/services/www/src/docs/content/console/go.mdx index 7f6b990d12f..b261413befe 100644 --- a/services/www/src/docs/content/console/go.mdx +++ b/services/www/src/docs/content/console/go.mdx @@ -85,7 +85,7 @@ Your client should: ### Validated clients Besides OpenCode, the following clients have been validated to work properly -with OpenCode Go. Although we do not guarantee that they will continue to work in the future. +with OpenCode Go, although we do not guarantee that they will continue to work in the future. | Client | Session support | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/services/www/src/docs/content/index.mdx b/services/www/src/docs/content/index.mdx index 4ffd0230c20..a8d9bfe66f9 100644 --- a/services/www/src/docs/content/index.mdx +++ b/services/www/src/docs/content/index.mdx @@ -55,9 +55,9 @@ Access the OpenCode web interface with the `opencode pair` command. ```bash $ opencode pair - URLs http://127.0.0.1:49374 - Username opencode - Password ******** + Open a link to connect. Links work once and expire in 5 minutes. + + http://127.0.0.1:49374/auth/connect/... ``` ## Docker @@ -68,7 +68,7 @@ Docker images use versioned tags, for example `ghcr.io/anomalyco/opencode:2.0.0` ## Connect -OpenCode has built in support for many LLM providers - you can connect to them +OpenCode has built-in support for many LLM providers. You can connect to them directly [in the TUI](/cli/providers) with `/connect`. See [Providers](/providers) to configure custom providers. @@ -76,8 +76,8 @@ See [Providers](/providers) to configure custom providers. If you'd like easy access to all the best coding models you can try out [OpenCode Console](/console). -You can also try [OpenCode Go](/console/go) a $10/month subscription -plan that grants you access to the best open source models. +You can also try [OpenCode Go](/console/go), a $10/month subscription +plan that grants you access to the best coding models. --- diff --git a/services/www/src/docs/content/themes.mdx b/services/www/src/docs/content/themes.mdx index 472ac15fe84..eb360c5ae59 100644 --- a/services/www/src/docs/content/themes.mdx +++ b/services/www/src/docs/content/themes.mdx @@ -221,7 +221,7 @@ palette: | Group | Purpose | | ------------ | ------------------------------------------------------------- | -| `text` | Base, muted, action, form-field, and feedback text | +| `text` | Base, muted, faint, action, form-field, and feedback text | | `background` | Base, surfaces, actions, form fields, and feedback fills | | `border` | Borders | | `scrollbar` | Scrollbars |