docs: initial project map + handoff/decisions skeleton + README rewrite (#32)
* docs: add skeleton .gitkeep files * docs: rewrite README for public release * docs(handoff): add pr-9 handoff + ADR-012 * docs(handoff): set PR number in filenames * docs: fix stale PR refs in handoff --------- Co-authored-by: opencode-agent <agent@slaid098.dev>
This commit is contained in:
parent
109fff628f
commit
954b5b71af
6 changed files with 77 additions and 1 deletions
45
README.md
45
README.md
|
|
@ -4,6 +4,8 @@ Docker-based AI coding assistant with persistent memory — opencode configurati
|
|||
|
||||
## Quick start
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
git clone https://github.com/slaid098/opencode-config.git
|
||||
cd opencode-config
|
||||
|
|
@ -14,10 +16,51 @@ docker compose up -d
|
|||
|
||||
Access at http://localhost:4096.
|
||||
|
||||
### Bare (without Docker)
|
||||
|
||||
```bash
|
||||
git clone https://github.com/slaid098/opencode-config.git
|
||||
cd opencode-config
|
||||
opencode # .opencode/ auto-discovered
|
||||
```
|
||||
|
||||
## Structure
|
||||
|
||||
- `.opencode/` — global opencode config (agents, skills, tools, scripts)
|
||||
- `AGENTS.md` — global orchestrator rules (main agent = plan only, all via subagents)
|
||||
- `.opencode/` — project-local config (auto-discovered, zero env var)
|
||||
- `agents/` — subagent definitions (docs-reviewer, memory-syncer, reviewer)
|
||||
- `commands/` — slash commands (run-pipeline, spec, configure-opencode)
|
||||
- `skills/` — skill definitions (14 skills)
|
||||
- `tools/` — custom tools (pipeline-status, spec-status, merge-pr)
|
||||
- `scripts/` — Python scripts (pipeline-status, spec-status, check-adr-refs, etc.)
|
||||
- `opencode.json` — main config (providers, MCP servers, permissions)
|
||||
- `app_data/workspaces/` — agent working directory
|
||||
- `app_data/ssh/` — SSH keys (not in git)
|
||||
- `app_data/opencode-memory/` — persistent memory (separate git repo)
|
||||
- `src/` — Python RAG CLI (second-brain)
|
||||
- `docs/` — handoffs, decisions (ADRs), project map
|
||||
- `.github/workflows/` — CI workflows (ubuntu-latest)
|
||||
|
||||
## Configuration
|
||||
|
||||
Copy `.env.example` to `.env` and fill in:
|
||||
|
||||
| Variable | Description |
|
||||
|----------|-------------|
|
||||
| `AI_PROVIDER_BASE_URL` | AI provider API URL |
|
||||
| `AI_PROVIDER_API_KEY` | AI provider API key |
|
||||
| `OPENCODE_SERVER_PASSWORD` | opencode server password |
|
||||
| `GITHUB_TOKEN` | GitHub personal access token |
|
||||
| `CONTEXT7_API_KEY` | Context7 MCP API key |
|
||||
| `ANTIDETECT_BROWSER_MCP_URL` | Antidetect browser MCP URL (optional) |
|
||||
|
||||
## Memory setup
|
||||
|
||||
Memory uses `@mathew-cf/opencode-memory` plugin (hybrid search: ripgrep + local RAG).
|
||||
|
||||
- `OPENCODE_MEMORY_DIR` env var points to memory directory (default: `app_data/opencode-memory/`)
|
||||
- Run `.opencode/scripts/setup-memory.sh` to initialize memory repo
|
||||
|
||||
## License
|
||||
|
||||
MIT — see [LICENSE](LICENSE)
|
||||
0
docs/.gitkeep
Normal file
0
docs/.gitkeep
Normal file
0
docs/decisions/.gitkeep
Normal file
0
docs/decisions/.gitkeep
Normal file
16
docs/decisions/012-pr-32-docs-skeleton-readme.md
Normal file
16
docs/decisions/012-pr-32-docs-skeleton-readme.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
# ADR-012: docs skeleton + public README
|
||||
|
||||
## Статус
|
||||
Accepted
|
||||
|
||||
## Контекст
|
||||
New public repo needs docs/ skeleton for handoffs/ADRs + complete README for users.
|
||||
|
||||
## Решение
|
||||
- docs/ .gitkeep files (skeleton)
|
||||
- README.md: Quick start (Docker + Bare), Structure, Configuration, Memory, License
|
||||
- docs/project-map/ already created in PR #18
|
||||
|
||||
## Альтернативы
|
||||
- Keep minimal README — отклонено (public repo needs full docs)
|
||||
- Skip docs/ skeleton — отклонено (pipeline-driver requires docs/handoff/ + docs/decisions/)
|
||||
0
docs/handoff/.gitkeep
Normal file
0
docs/handoff/.gitkeep
Normal file
17
docs/handoff/pr-32-docs-skeleton-readme.md
Normal file
17
docs/handoff/pr-32-docs-skeleton-readme.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# PR: docs skeleton + README rewrite
|
||||
|
||||
## Что сделано
|
||||
- docs/ skeleton: .gitkeep files for docs/, decisions/, handoff/ (if missing)
|
||||
- README.md: full public README (Quick start Docker + Bare, Structure, Configuration, Memory setup, License)
|
||||
- docs/project-map/README.md: already exists (from PR #18), updated if needed
|
||||
|
||||
## Почему
|
||||
Public repo needs complete README for users. docs/ skeleton for future PR handoffs/ADRs.
|
||||
|
||||
## Pending
|
||||
- Нет (финальный PR миграции)
|
||||
|
||||
## Watch out
|
||||
- README references AGENTS.md (PR#31), /run-pipeline command (PR#29), merge_pr tool (PR#30) — all merged
|
||||
- .env.example + docker-compose from PR#24
|
||||
- Memory plugin @mathew-cf/opencode-memory
|
||||
Loading…
Add table
Reference in a new issue