Skip to content

Commit 65bae66

Browse files
committed
docs: update documentation to reference .opencode paths
1 parent 0bc586d commit 65bae66

7 files changed

Lines changed: 167 additions & 177 deletions

File tree

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This interactive script will:
3030
2. **Clone** the latest framework components to a temporary location.
3131
3. **Analyze** your current directory and propose a list of files to create or update.
3232
4. **Prompt** for your explicit confirmation before applying any changes.
33-
5. **Integrate** the `.gemini/` configuration and framework files (non-destructively).
33+
5. **Integrate** the `.opencode/` configuration and framework files (non-destructively).
3434
6. **Commit** the changes automatically with a descriptive message.
3535

3636
Once the installation is complete, run `gemini /onboard` to get an overview of the repository and start your first session.
@@ -54,12 +54,11 @@ This repository is a heavily customized and oppinionanted Gemini CLI agent, read
5454

5555
## 🛠️ The Project Lifecycle
5656

57-
The `.gemini/commands/` directory defines specialized workflows that automate every phase of the development lifecycle:
57+
The `.opencode/commands/` directory defines specialized workflows that automate every phase of the development lifecycle:
5858

5959
### 🔍 Phase 1: Planning & Discovery
6060
* **`/research <topic>`**: A deep, 3-phase investigation (Planning -> Data Gathering -> Reporting) that produces exhaustive Markdown reports in the `research/` directory. **Crucial for gathering technical requirements and state-of-the-art context.**
61-
* **`/learn <topic>`**: A grounded learning lifecycle (Audit -> Strategic Mapping -> Execution -> Codification) for mastering new technologies and building a permanent, machine-readable knowledge base in `.gemini/skills/` using the specialized `learner` subagent.
62-
* **`/brainstorm`**: An interactive, high-signal brainstorming session. The agent acts as a critical partner—challenging your assumptions, identifying architectural risks, and asking hard follow-up questions—without making any changes to the codebase.
61+
* **`/learn <topic>`**: A grounded learning lifecycle for mastering new technologies through structured exploration and experimentation.* **`/brainstorm`**: An interactive, high-signal brainstorming session. The agent acts as a critical partner—challenging your assumptions, identifying architectural risks, and asking hard follow-up questions—without making any changes to the codebase.
6362
* **`/plan`**: The **Architectural Bridge**. This interactive workflow translates ideas into actionable execution plans:
6463
* **Phase 1 (Clarification):** The agent interviews you to resolve ambiguities before planning.
6564
* **Phase 2 (Agentic Analysis):** A specialized `planner` subagent scans the codebase and generates a detailed technical strategy.
@@ -107,16 +106,15 @@ This framework shines when you combine these commands into cohesive workflows:
107106
2. **Draft:** Run `/draft` to build an outline and expand it into a full article.
108107
3. **Review:** Use `/review` for non-destructive, multi-phase audits and refinements.
109108

110-
## The Hook System
109+
## Pre-Commit Validation
111110

112-
The framework uses a dual-layer hook system to synchronize the agent with your project state:
111+
The framework uses a git pre-commit hook to enforce engineering standards:
113112

114-
* **`session.py` / `welcome.py`**: Initialize the environment, provide a project summary, and check for environment readiness.
115-
* **`log.py`**: Provides a comprehensive, structured audit trail of every agent turn and tool execution.
116-
* **`notify.py`**: Sends a desktop notification and sound when the agent completes its work, minimizing downtime.
117-
* **`cron.py`**: Synchronizes repetitive tasks with **systemd user timers**.
118-
* **`pre-commit.py` (Git Hook)**: Enforces daily journaling and timestamp-based validation before any code changes are finalized.
113+
* **`git-precommit.py` (Git Hook)**: Enforces daily journaling and timestamp-based validation before any code changes are finalized.
119114
* **`journal.py` (Script)**: The dedicated utility for correctly formatting and appending new journal entries.
115+
* **`task.py` (Script)**: Manages the project roadmap in `TASKS.md`.
116+
117+
Install hooks with: `make install-hooks`
120118

121119
## 📄 License & Contribution
122120

docs/deploy.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ curl -fsSL https://apiad.github.io/starter/install.sh | bash
1515
Running `install.sh` in an empty directory will:
1616

1717
- Initialize a fresh Git repository.
18-
- Extract the core `.gemini/` framework and configuration files.
18+
- Extract the core `.opencode/` framework and configuration files.
1919
- Create the standard project structure (`journal/`, `plans/`, `research/`, `drafts/`).
2020
- Initialize baseline files (`README.md`, `CHANGELOG.md`, `TASKS.md`, `makefile`).
2121
- Perform an initial "feat" commit.
@@ -25,10 +25,10 @@ Running `install.sh` in an empty directory will:
2525
If run inside an existing project, the script performs a **Surgical Update**:
2626

2727
- **Validate:** Ensure a clean Git working tree to prevent data loss.
28-
- **Surgical Sync:** Updates core framework components (`hooks/`, `commands/`, `agents/`, `scripts/`) individually.
28+
- **Surgical Sync:** Updates core framework components (`commands/`, `agents/`, `tools/`) individually.
2929
- **Protection:** Explicitly preserves user configurations in **Protected Files**:
30-
- `.gemini/settings.json`
31-
- `.gemini/style-guide.md`
30+
- `opencode.json`
31+
- `.opencode/style-guide.md`
3232
- **Intelligent GEMINI.md Merge:** Preserves your custom content in the `## Project Notes` section of `GEMINI.md` while updating the core mandates above it.
3333
- **Confirm:** Presents a detailed summary of which files will be **created**, **updated**, or **protected** and waits for your approval.
3434
- **Integrate:** Adds missing directory structures (`journal/`, `plans/`, etc.) if they don't exist.
@@ -40,7 +40,7 @@ To ensure full functionality, your environment should have:
4040

4141
- **Git:** Required for state management and change detection hooks.
4242
- **Node.js:** Necessary for running the `gemini` CLI.
43-
- **Python 3.12+:** Required for executing the project's automation hooks (`.gemini/hooks/`).
43+
- **Python 3.12+:** Required for executing the project's automation scripts in `.opencode/tools/`.
4444
- **uv:** The required Python package and project manager.
4545
- **Make:** Used for project validation and health checks (runs `uv run pytest`).
4646

@@ -52,7 +52,7 @@ After installation, you **must** link the framework's hooks to your git reposito
5252
make install-hooks
5353
```
5454

55-
This target creates a symbolic link from `.gemini/hooks/pre-commit.py` to `.git/hooks/pre-commit`, enabling the automated journal and validation checks.
55+
This target creates a symbolic link from `.opencode/tools/git-precommit.py` to `.git/hooks/pre-commit`, enabling the automated journal and validation checks.
5656

5757
## 🚢 Getting Started
5858

@@ -70,10 +70,6 @@ gemini /onboard
7070

7171
Check the current `TASKS.md` file and use the `/task` command to define your project's initial goals.
7272

73-
### 3. Codified Knowledge
74-
75-
Knowledge mastered via `/learn` is stored in `.gemini/skills/`. These are permanent project assets and **must** be tracked in version control to ensure the AI's long-term memory persists across environments.
76-
7773
### 3. Start a New Feature
7874

7975
For your first feature, follow the standard workflow:

0 commit comments

Comments
 (0)