diff --git a/.gitignore b/.gitignore index a14dc19..9859605 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,9 @@ -# OpenCode Everything You Need to Know - .gitignore -# This file specifies intentionally untracked files that Git should ignore +# OpenCode Everything You Need to Know — .gitignore +# We intentionally COMMIT the example .opencode/agents/, /commands/, and /skills/ +# so readers can see a real configured project. Only user-specific runtime state +# under .opencode/ is ignored. # ==================== SYSTEM FILES ==================== -# macOS system files .DS_Store .DS_Store? ._* @@ -10,55 +11,47 @@ .Trashes .AppleDouble .LSOverride - -# Windows system files Thumbs.db ehthumbs.db Desktop.ini $RECYCLE.BIN/ - -# Linux temporary files *~ *.swp *.swo -# ==================== EDITOR/IDE FILES ==================== -# Visual Studio Code +# ==================== EDITOR / IDE ==================== .vscode/ !.vscode/settings.json !.vscode/tasks.json !.vscode/launch.json !.vscode/extensions.json *.code-workspace - -# IntelliJ IDEA .idea/ *.iml *.iws *.ipr - -# Other editors .project .classpath .settings/ -# ==================== OPENCODE RUNTIME FILES ==================== -# OpenCode configuration and runtime files (user-specific) +# ==================== OPENCODE RUNTIME (user-specific) ==================== +# These are local to each user's machine — never commit. .opencode/node_modules/ -.opencode/package.json -.opencode/bun.lock -.opencode/.gitignore .opencode/cache/ .opencode/logs/ .opencode/sessions/ -.opencode/config.local.json .opencode/state.json -.opencode/agents/ -.opencode/commands/ -.opencode/skills/ +.opencode/config.local.json +.opencode/audit.jsonl +.opencode/.gitignore +# Plugin-dev scratch files (kept out of the example showcase) +.opencode/package.json +.opencode/bun.lock + +# NOTE: agents/, commands/, skills/, plugins/, themes/ subfolders ARE committed — +# they're the worked example we want readers to see. # ==================== DEPENDENCIES ==================== -# Node.js dependencies node_modules/ npm-debug.log* yarn-debug.log* @@ -68,20 +61,16 @@ yarn.lock bun.lock # ==================== BUILD OUTPUTS ==================== -# Documentation build outputs -docs/_build/ -docs/_site/ -docs/_out/ - -# General build outputs dist/ build/ .out/ .next/ .nuxt/ +docs/_build/ +docs/_site/ +docs/_out/ -# ==================== ENVIRONMENT FILES ==================== -# Environment variables (never commit secrets!) +# ==================== ENVIRONMENT ==================== .env .env.local .env.development.local @@ -89,8 +78,7 @@ build/ .env.production.local .env.*.local -# ==================== TEMPORARY FILES ==================== -# Temporary files +# ==================== TEMPORARY ==================== tmp/ temp/ *.tmp @@ -100,49 +88,29 @@ temp/ *.old # ==================== LOGS ==================== -# Log files *.log logs/ -.opencode/logs/ -# ==================== COVERAGE REPORTS ==================== -# Test coverage +# ==================== COVERAGE ==================== coverage/ .nyc_output *.lcov -# ==================== OS-SPECIFIC IGNORES ==================== -# Network files +# ==================== OS-SPECIFIC ==================== Network Trash Folder Temporary Items .apdisk # ==================== PROJECT-SPECIFIC ==================== -# Example projects dependencies examples/*/node_modules examples/*/package-lock.json examples/*/yarn.lock examples/*/bun.lock - -# Plugin development plugins/*/node_modules plugins/*/dist plugins/*/build - -# MCP server development mcp-servers/*/node_modules mcp-servers/*/dist mcp-servers/*/build - -# Image processing cache -Images/.DS_Store Images/thumbnails/ - -# TypeScript cache *.tsbuildinfo - -# ==================== PERSONAL WORKSPACE ==================== -# Personal workspace files (optional - comment out if you want to track these) -# .workspace/ -# personal-notes.md -# todo.md \ No newline at end of file diff --git a/docs/QUICKSTART.md b/docs/quickstart.md similarity index 100% rename from docs/QUICKSTART.md rename to docs/quickstart.md diff --git a/docs/WORKFLOWS.md b/docs/workflows.md similarity index 100% rename from docs/WORKFLOWS.md rename to docs/workflows.md