docs: add guides so users can get started faster
Summary
- Adds a new Guides section to the documentation navigation
- Creates a comprehensive "First Hour" guide to help new users get productive quickly
What's in the guide
The guide follows a progressive disclosure pattern - essentials up front, details as you read further:
- Quick start essentials - bullet list of the 5 things you need to know
- Installation - links to install options
-
Provider setup - promotes OpenCode Zen, includes
opencode auth loginoption -
Project initialization -
/initcommand -
File references - using
@to reference files - Plan-Build workflow - core workflow explanation with table
- Undo/redo - safety net for mistakes
-
Shell commands -
!prefix -
Sharing -
/sharecommand - Quick tips - context, mentoring tone, image paste (Ctrl+V)
-
MCP servers - Context7 and Exa setup with:
- Config location explanation (global vs project)
- Global config example for Context7/Exa
- Project config example for Neon Postgres
- Cheat sheet - quick reference table
Changes
-
packages/web/astro.config.mjs- Added Guides section to sidebar -
packages/web/src/content/docs/guides/first-hour.mdx- New guide (356 lines)
OC Session: https://opncd.ai/share/bI5W0WPS
Going to have Jay look over this
already helped 2 people
I think the first hour one should be merged into this doc, they are both doing very similar things, maybe rename section in the current doc to emphasize that it's a guide for new users: https://opencode.ai/docs/#initialize
The commands doc has similar content to this one, I think we should merge that too: https://opencode.ai/docs/commands/
We cover subagents here: https://opencode.ai/docs/agents/#subagents. We should probably add to that doc if we can, but open to creating a new doc for this.
@jayair yeah good points
heres my thinking for adding the guides:
the existing docs are reference-oriented - they document all options and configurations. Great for "how do I configure X?" but less helpful for "when should I use X in my workflow?"
the guides add a TL;DR section at the top (learn/understand/value in 30 seconds)
for example, commands.mdx documents all 5 config options. The guide shows 8 real-world commands (PR reviewer, test runner, etc.) and explains when to use subtask: true.
thoughts?
I think I will merge the commands guide with the commands docs reference, after reviewing more it looks like it fits better.