summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGuofang.Tang <[email protected]>2026-01-06 12:45:40 +0800
committerGitHub <[email protected]>2026-01-05 22:45:40 -0600
commit9197a2a7a169cfbee1169073c798fe8b11da9750 (patch)
tree612e0d85fbe25c9448eac10bf0ca24918e17eb13
parent8da890649f14d3cf78ef6c0917eae08f2b66d0c9 (diff)
downloadopencode-9197a2a7a169cfbee1169073c798fe8b11da9750.tar.gz
opencode-9197a2a7a169cfbee1169073c798fe8b11da9750.zip
docs: polish markdown wording and capitalization (#7019)
Co-authored-by: Tang Guofang <[email protected]>
-rw-r--r--README.md3
-rw-r--r--packages/app/README.md4
-rw-r--r--packages/desktop/README.md2
-rw-r--r--packages/opencode/src/provider/sdk/openai-compatible/src/README.md6
-rw-r--r--specs/project.md3
5 files changed, 8 insertions, 10 deletions
diff --git a/README.md b/README.md
index a5b35466c..15c382e63 100644
--- a/README.md
+++ b/README.md
@@ -70,8 +70,7 @@ XDG_BIN_DIR=$HOME/.local/bin curl -fsSL https://opencode.ai/install | bash
### Agents
-OpenCode includes two built-in agents you can switch between,
-you can switch between these using the `Tab` key.
+OpenCode includes two built-in agents you can switch between with the `Tab` key.
- **build** - Default, full access agent for development work
- **plan** - Read-only agent for analysis and code exploration
diff --git a/packages/app/README.md b/packages/app/README.md
index 6a1764536..bd10e6c8d 100644
--- a/packages/app/README.md
+++ b/packages/app/README.md
@@ -1,8 +1,8 @@
## Usage
-Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.
+Dependencies for these templates are managed with [pnpm](https://pnpm.io) using `pnpm up -Lri`.
-This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
+This is the reason you see a `pnpm-lock.yaml`. That said, any package manager will work. This file can safely be removed once you clone a template.
```bash
$ npm install # or pnpm install or yarn install
diff --git a/packages/desktop/README.md b/packages/desktop/README.md
index b381dcf5b..7567e65f5 100644
--- a/packages/desktop/README.md
+++ b/packages/desktop/README.md
@@ -1,6 +1,6 @@
# Tauri + Vanilla TS
-This template should help get you started developing with Tauri in vanilla HTML, CSS and Typescript.
+This template should help get you started developing with Tauri in vanilla HTML, CSS and TypeScript.
## Recommended IDE Setup
diff --git a/packages/opencode/src/provider/sdk/openai-compatible/src/README.md b/packages/opencode/src/provider/sdk/openai-compatible/src/README.md
index 593e64453..8ce03d614 100644
--- a/packages/opencode/src/provider/sdk/openai-compatible/src/README.md
+++ b/packages/opencode/src/provider/sdk/openai-compatible/src/README.md
@@ -1,5 +1,5 @@
-This is a temporary package used primarily for github copilot compatibility.
+This is a temporary package used primarily for GitHub Copilot compatibility.
-Avoid making changes to these files unless you want to only affect Copilot provider.
+Avoid making changes to these files unless you only want to affect the Copilot provider.
-Also this should ONLY be used for Copilot provider.
+Also, this should ONLY be used for the Copilot provider.
diff --git a/specs/project.md b/specs/project.md
index dd51f0e7f..97bacbbca 100644
--- a/specs/project.md
+++ b/specs/project.md
@@ -1,7 +1,6 @@
## project
-goal is to let a single instance of opencode be able to run sessions for
-multiple projects and different worktrees per project
+The goal is to let a single instance of OpenCode run sessions for multiple projects and different worktrees per project.
### api