chore: ship example opencode.json, tui.json, and Images/ guidance

- opencode.json: a real, runnable project config with safe defaults —
  edit:"ask", glob-pattern bash map (auto-allow common read-only ops,
  deny rm -rf and git push --force), webfetch and websearch on "ask",
  external_directory denied. Useful as a starting point readers can
  copy verbatim.
- tui.json: minimal example covering theme, scroll speed, leader
  timeout, keybinds, attention/notifications.
- Images/README.md: replaces .gitkeep with explicit contribution rules
  — no copyrighted material, prefer SVG over PNG, prefer mermaid over
  raster when the concept fits.
This commit is contained in:
Wesam Abousaid
2026-05-18 20:00:35 +02:00
parent d75be39290
commit cbb87bff3f
3 changed files with 78 additions and 0 deletions
+20
View File
@@ -0,0 +1,20 @@
# Images/
Diagrams, screenshots, and visual assets for this guide.
## Contribution rules
- **No copyrighted material** without an explicit license. Don't drop the OpenCode logo here — we're not affiliated with the OpenCode team.
- **Prefer SVG over PNG** for diagrams. They scale and are diff-friendly.
- **Reference inline** from the relevant doc:
```markdown
![Alt text describing the image](Images/your-image.svg)
```
- **Include alt text.** Always.
- **Mermaid before raster.** When a concept can be expressed as a flowchart or sequence diagram, prefer Mermaid (renders natively on GitHub) over an exported PNG. See [`docs/mcp.md`](../docs/mcp.md) for an example.
## What lives here
Currently empty — contributions welcome. See [`CONTRIBUTING.md`](../CONTRIBUTING.md).
+43
View File
@@ -0,0 +1,43 @@
{
"$schema": "https://opencode.ai/config.json",
"model": "anthropic/claude-sonnet-4-5",
"share": "manual",
"autoupdate": "notify",
"instructions": ["AGENTS.md", "CONTRIBUTING.md"],
"permission": {
"edit": "ask",
"bash": {
"*": "ask",
"ls *": "allow",
"ls": "allow",
"cat *": "allow",
"git status*": "allow",
"git diff*": "allow",
"git log*": "allow",
"git show*": "allow",
"grep *": "allow",
"rg *": "allow",
"find . *": "allow",
"wc *": "allow",
"head *": "allow",
"tail *": "allow",
"rm -rf*": "deny",
"rm *": "ask",
"git push --force*": "deny",
"git reset --hard*": "deny",
"curl *": "ask",
"npm publish*": "deny"
},
"webfetch": "ask",
"websearch": "ask",
"external_directory": "deny"
},
"agent": {
"build": {
"model": "anthropic/claude-sonnet-4-5"
},
"plan": {
"model": "anthropic/claude-haiku-4-5"
}
}
}
+15
View File
@@ -0,0 +1,15 @@
{
"$schema": "https://opencode.ai/tui.json",
"theme": "tokyonight",
"scroll_speed": 3,
"leader_timeout": 2000,
"keybinds": {
"command_list": "ctrl+p"
},
"attention": {
"enabled": true,
"notifications": true,
"sound": false,
"volume": 0.4
}
}