Browse Source

chore: troubleshooting docs

adamdottv 7 months ago
parent
commit
8e9e383219

+ 2 - 1
packages/web/astro.config.mjs

@@ -65,6 +65,7 @@ export default defineConfig({
         "docs/themes",
         "docs/keybinds",
         "docs/mcp-servers",
+        "docs/troubleshooting",
       ],
       components: {
         Hero: "./src/components/Hero.astro",
@@ -79,6 +80,6 @@ export default defineConfig({
     }),
   ],
   redirects: {
-    "/discord": "https://discord.gg/invite/opencode",
+    "/discord": "https://discord.com/invite/opencode",
   },
 })

+ 74 - 0
packages/web/src/content/docs/docs/troubleshooting.mdx

@@ -0,0 +1,74 @@
+---
+title: Troubleshooting
+description: Common issues and how to resolve them.
+---
+
+## Logs
+
+opencode writes detailed logs that can help diagnose issues. Log files are stored in:
+
+- **macOS/Linux**: `~/.local/share/opencode/log/`
+- **Windows**: `%APPDATA%\opencode\log\`
+
+Log files are named with timestamps (e.g., `2025-01-09T123456.log`) and the most recent 10 log files are kept.
+
+You can configure the log level in your [config file](/docs/config#logging) to get more detailed debug information.
+
+---
+
+## Storage
+
+opencode stores session data and other application data on disk at:
+
+- **macOS/Linux**: `~/.local/share/opencode/`
+- **Windows**: `%APPDATA%\opencode\`
+
+This directory contains:
+
+- `auth.json` - Authentication data (e.g., API keys, OAuth tokens)
+- `log/` - Application logs
+- `project/` - Project-specific data (e.g., session and message data)
+
+---
+
+## Getting help
+
+If you're experiencing issues with opencode:
+
+### Report issues on GitHub
+
+The best way to report bugs or request features is through our GitHub repository:
+
+[**github.com/sst/opencode/issues**](https://github.com/sst/opencode/issues)
+
+Before creating a new issue, please search existing issues to see if your problem has already been reported.
+
+### Join our Discord
+
+For real-time help and community discussion, join our Discord server:
+
+[**opencode.ai/discord**](https://opencode.ai/discord)
+
+Our community and team are happy to help with questions and troubleshooting.
+
+---
+
+## Common issues
+
+### opencode won't start
+
+1. Check the logs for error messages
+2. Try running with `--print-logs` to see output in the terminal
+3. Ensure you have the latest version with `opencode upgrade`
+
+### Authentication issues
+
+1. Try re-authenticating with `opencode auth login <provider>`
+2. Check that your API keys are valid
+3. Ensure your network allows connections to the provider's API
+
+### Model not available
+
+1. Check that you've authenticated with the provider
+2. Verify the model name in your config is correct
+3. Some models may require specific access or subscriptions