You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Replace 'Gemini CLI' with 'OpenCode Framework'
- Replace /maintenance with /audit throughout
- Remove references to unimplemented commands (/learn, /document, /brainstorm, /cron)
- Update directory paths to .knowledge/* structure
- Update install.sh to non-interactive mode with --link flag
- Fix install URLs to apiad.github.io/opencode
- Update agent and subagent tables to match actual implementation
The documentation has significant drift from the current implementation. Multiple commands referenced don't exist, directory structures are outdated, and install URLs are inconsistent across files. New users following the docs would encounter broken commands and incorrect paths.
| Directory Structure |**high**|`design.md` shows old dirs (`plans/`, `journal/`, `research/`, `drafts/`) but actual is `.knowledge/plans/`, `.knowledge/log/`, `.knowledge/notes/`, `.knowledge/drafts/`|`docs/design.md:115-127`| Update to show `.knowledge/*` structure |
49
+
| Missing Commands |**high**|`/maintenance`, `/document`, `/brainstorm`, `/cron`, `/learn` are documented but don't exist | Multiple docs | Either implement or remove from docs |
50
+
| Install URLs |**high**| Inconsistent URLs: `apiad.github.io/starter` vs `apiad.github.io/opencode`|`docs/index.md:39`, `docs/deploy.md:76-91`| Standardize to `apiad.github.io/opencode`|
51
+
| CLI Name |**high**| Docs reference `gemini` CLI but actual CLI is `opencode`|`docs/deploy.md:146,157`| Replace all `gemini` with `opencode`|
52
+
| Wrong Install Flag |**medium**|`docs/deploy.md` shows `--mode=link` but install.sh uses `--link`|`docs/deploy.md:76,79`| Update to match actual flag syntax |
53
+
| Agent-Command Mismatch |**medium**|`design.md` shows agents not in commands, e.g., `query`, `write`, `review`|`docs/design.md:7-17`| Document actual commands or reconcile |
54
+
| Missing `/revise`|**low**| Referenced as "legacy" but implementation unclear |`docs/user-guide.md:227`| Clarify if this command exists |
55
+
56
+
### Technical Debt
57
+
58
+
1.**Orphaned Plans** β Multiple `.knowledge/plans/` files for features that may not be implemented:
59
+
-`add-brainstorm-command.md` β `/brainstorm` not implemented
60
+
-`implement-learn-command.md` β `/learn` not implemented
61
+
-`implement-maintenance-v2.md` β `/maintenance` not implemented
62
+
63
+
2.**Outdated Terminology**
64
+
- "Tier Protocol" in `docs/index.md:49` β no corresponding implementation
65
+
- "Context Minifier" in `docs/develop.md:75` and `docs/user-guide.md:18` β no documented implementation
66
+
67
+
3.**Install Script Issues**
68
+
- Uses `--link` but docs show `--mode=link` and `--mode=copy`
69
+
-`REPO_URL` points to `opencode-core` but should document which repo
70
+
71
+
---
72
+
73
+
## Recommendations
74
+
75
+
### Priority 1: Fix Critical Path Issues
76
+
77
+
1.**Update install URL everywhere** to `https://apiad.github.io/opencode/install.sh`
78
+
-`docs/index.md:39`
79
+
-`docs/deploy.md:76,79,91`
80
+
-`docs/updating.md:14,26,40,52,62,122,156`
81
+
82
+
2.**Replace CLI name**`gemini` β `opencode` in:
83
+
-`docs/deploy.md:146,157`
84
+
- Any other occurrences
85
+
86
+
3.**Fix `--mode=` β `--link`/`--copy`** in `docs/deploy.md:76-79` and `docs/updating.md`
87
+
88
+
4.**Update directory structure** in `docs/design.md:115-127`:
Copy file name to clipboardExpand all lines: docs/deploy.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Installation & Setup
2
2
3
-
Getting the **Gemini CLI Opinionated Framework** up and running is an automated, interactive process. Whether you're starting a new project or integrating into an existing one, the `install.sh` script is your primary tool.
3
+
Getting the **OpenCode Framework** up and running is an automated, non-interactive process. Whether you're starting a new project or integrating into an existing one, the `install.sh` script is your primary tool.
4
4
5
5
## Installation Modes
6
6
@@ -73,13 +73,13 @@ To switch modes, run the installer with the desired mode:
2.**Strategy:**`/plan` generates actionable roadmaps in `plans/`
57
-
3.**Execution:**`/task` (code) or `/draft` (prose) perform actual work
52
+
1.**Discovery:**`/research`, `/audit`, `/debug` create read-only artifacts in `.knowledge/notes/`
53
+
2.**Strategy:**`/plan` generates actionable roadmaps in `.knowledge/plans/`
54
+
3.**Execution:**`/build` (code) or `/draft` (prose) perform actual work
58
55
59
56
## π TCR (Test-Commit-Revert) Protocol
60
57
61
-
The `/task work` command enforces a high-discipline development lifecycle through a strict TCR loop:
58
+
The `/build` command enforces a high-discipline development lifecycle through a strict TCR loop:
62
59
63
60
1.**Pre-flight Verification:** Ensures a clean `main` branch and passing tests.
64
61
2.**Isolation:** All work occurs on an auto-generated, kebab-case feature branch.
@@ -68,29 +65,17 @@ The `/task work` command enforces a high-discipline development lifecycle throug
68
65
-**Verify:** If the test fails, the agent is allowed **one quick fix**. If it fails again, the change is **automatically reverted** (`git checkout .`), preserving the last known stable state.
69
66
4.**Integration:** Upon completion, the feature branch is merged, the roadmap is updated, and the branch is deleted.
70
67
71
-
## π Procedural Task Management
72
-
73
-
The `tasks.yaml` file is managed exclusively via the `task` tool:
68
+
## π Task Management
74
69
75
-
-**Single source of truth** for project roadmap
76
-
-**State lifecycle:**`add` (Todo) β `start` (In Progress) β `archive` (Done)
77
-
-**Never edit `tasks.yaml` by hand** β always use the task tool
70
+
Tasks are managed via the `todowrite` tool within agent sessions:
78
71
79
-
!!! warning "Migrating from TASKS.md"
80
-
If you have an existing `TASKS.md` file, instruct the model to migrate it:
0 commit comments