Introduce a GETTING_STARTED.md file with full walk through#327
Introduce a GETTING_STARTED.md file with full walk through#327DevinVinson wants to merge 5 commits into
Conversation
|
@DevinVinson is attempting to deploy a commit to the openhands Team on Vercel. A member of the Team first needs to authorize it. |
- Add section explaining users must install openhands-automation skill - Include /add-skill command for installing the skill - Update README documentation section to link all three guides Co-authored-by: openhands <openhands@all-hands.dev>
|
|
||
| #### Option A: OpenHands Cloud (Easiest) | ||
|
|
||
| **Recommended for new users.** A single OpenHands API key gives you access to most major AI models (Claude, GPT-4, Gemini, and more) without needing separate accounts with each provider. |
There was a problem hiding this comment.
I’m with you on the goal here, but this does not seem the easiest:
- step 3 will fail for new users, because of the current requirement to add a credit card and use it.
Maybe we can remove easiest… Idk though, WDYT?
There was a problem hiding this comment.
Good point. I'd forgotten about the purchase requirement when I went through that workflow. I think I should rewrite the steps here.
There was a problem hiding this comment.
I realized the steps still confused LLM key for rest key here too. Updated with new commit.
Updated instructions for obtaining OpenHands Cloud API key, including new steps for logging in and copying the key.
enyst
left a comment
There was a problem hiding this comment.
Just to note, IMHO we will not need so many docs; maybe more like, a README for humans and the AGENTS.md for agents 😅. We were basically doing that in the SDK and CLI repos.
But it’s OK with me either way, we’ll see where we get as we move forward.
Agreed. I wanted something to get in here that would then easily port over to documentation updates later. Agents will also likely help keep this up to date if major parts of the process change. |
|
Closing this out for now to reduce some of the PR noise. It'll be too stale without constant updates 😄 |
Summary
Adds a comprehensive Getting Started guide (
GETTING_STARTED.md) for new users of Agent Canvas. This guide walks users through installation, configuration, and first use of the application.What's Included
Installation
PROJECT_PATHwith copy-paste commandsOnboarding Walkthrough
Core Features
Reference Material
Notes