docs: consolidate first-time-setup into overview carousel#543
Closed
malhotra5 wants to merge 29 commits into
Closed
docs: consolidate first-time-setup into overview carousel#543malhotra5 wants to merge 29 commits into
malhotra5 wants to merge 29 commits into
Conversation
- Rename 'Onboarding OpenHands' group to 'Onboarding Agent Canvas' - Add agent-canvas docs (overview, setup, backends, llm-profiles, customize-and-settings, automations, self-hosting, development, troubleshooting) under Onboarding Agent Canvas - Move Hooks to Product Guides section - Update Quick Start to single 'Install OpenHands Agent Canvas' card with OpenHands Cloud as a bullet item Co-authored-by: openhands <openhands@all-hands.dev>
- Remove bullet points from Agent Canvas card in Quick Start - Add OpenHands Cloud as a single bullet below the card - Move Repository Customization to Product Guides, after Automations Co-authored-by: openhands <openhands@all-hands.dev>
- Rename 'Setup' page title to 'Install' - Add 'Setup a Pre-built Automation' group with placeholder sub-pages: GitHub PR Review Assistant, GitHub Repository Monitor, Slack Channel Monitor - Remove LLM Profiles and Model Configuration from nav - Add links to Skills and MCP Servers under Customize header in customize-and-settings - Remove stale llm-profiles link from Related Guides Co-authored-by: openhands <openhands@all-hands.dev>
- Convert flat backends entry to a nav group - Add placeholder sub-pages: Local, VM, Docker, OpenHands Cloud Co-authored-by: openhands <openhands@all-hands.dev>
…view - Move automations.mdx content into prebuilt-automations.mdx - Add intro section at top of prebuilt-automations linking to the three pre-built automation sub-pages (PR review, repo monitor, Slack) - Delete automations.mdx - Remove automations from Onboarding Agent Canvas nav Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Covers all four onboarding steps with screenshots: - Step 1: Choose your agent (OpenHands, Claude Code, Codex, Gemini CLI via ACP) - Step 2: Check your backend (local default, link to backends guide) - Step 3: Set up your LLM (BYOK + OpenHands Cloud link) - Step 4: Start from a proven workflow (GitHub PR Review Copilot + pre-built automations) Co-authored-by: openhands <openhands@all-hands.dev>
* docs: add custom Agent Server image guide for Docker backend Replace the placeholder Docker backend page with a full walkthrough: build a custom Agent Server image (FROM ghcr.io/openhands/agent-server, add JDK + utilities), run it locally with a SESSION_API_KEY, and register it as a backend in Agent Canvas. Co-authored-by: openhands <openhands@all-hands.dev> * docs: use agent-server-java name, port 8001, add multi-backend section Co-authored-by: openhands <openhands@all-hands.dev> * docs: pin agent server version in FROM example Co-authored-by: openhands <openhands@all-hands.dev> * docs: use 1-python base tag with short pinning tip Co-authored-by: openhands <openhands@all-hands.dev> --------- Co-authored-by: openhands <openhands@all-hands.dev>
- self-hosting.mdx: replace clone/npm-run-dev workflow with npx @openhands/agent-canvas --public one-liner. Remove nginx basic auth as the auth layer (--public handles it at the app level). Simplify security checklist and reverse proxy guidance. - setup.mdx: add --public flag to CLI table, add LOCAL_BACKEND_API_KEY to environment variables table. Co-authored-by: openhands <openhands@all-hands.dev>
Assumes the user has already installed via npm. Links to the install page for prerequisites. Co-authored-by: openhands <openhands@all-hands.dev>
Replace the technical component list with four user-facing value props: agent flexibility, LLM flexibility, built-in automations, deployment flexibility. Co-authored-by: openhands <openhands@all-hands.dev>
Replace six rows (UI, three backend flavors, Customize, Settings) with four focused concepts: Agent Canvas (UI + BE defined), Backend (any UI connects to any BE), Conversation, and Automation. Co-authored-by: openhands <openhands@all-hands.dev>
The target page title is already "Install". Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Reorder products: Agent Canvas first, then Cloud, Enterprise, SDK. Move CLI and Local GUI into a collapsible Legacy section. Co-authored-by: openhands <openhands@all-hands.dev>
Ports the ACP_AGENTS guide from the agent-canvas repo into the docs: what ACP agents are, supported providers, authentication (subscription login vs API key), onboarding, switching agent/model, and custom servers. Adds the page to the Onboarding Agent Canvas nav after Customize & Settings. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add missing --version and --info flags. Remove developer-only env vars (OH_AGENT_SERVER_GIT_REF, OH_AGENT_SERVER_LOCAL_PATH) — these belong in the Development guide, not the user-facing Install page. Co-authored-by: openhands <openhands@all-hands.dev>
Already covered by the --port flag in the CLI Flags table. Co-authored-by: openhands <openhands@all-hands.dev>
The all-in-one Docker image (ghcr.io/openhands/agent-canvas) is now available. Document the docker run command with volume mounts for persistence and projects, and show how to provide a custom API key. Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Present npm and Docker as two parallel install paths with their own prerequisites, matching the tab pattern used in the CLI docs. Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
npm tab gets CLI flags + env vars (including --public, --version, etc.). Docker tab gets its own env vars section (PORT, LOCAL_BACKEND_API_KEY, OH_SECRET_KEY) since the Docker entrypoint uses env vars, not CLI flags. Co-authored-by: openhands <openhands@all-hands.dev>
Remove the standalone First Time Setup page and add its four screenshots as a tab-based carousel under the "Why Agent Canvas" section in the overview. This consolidates the value prop and visual previews into one place. - Remove first-time-setup.mdx - Remove from docs.json navigation - Update prebuilt automation pages to drop the first-time-setup link - Add Tabs with setup step images to overview.mdx Co-authored-by: openhands <openhands@all-hands.dev>
malhotra5
force-pushed
the
docs/consolidate-first-time-setup
branch
from
88ce315 to
90efbd4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Remove the standalone First Time Setup page and add its four screenshots as a tab-based carousel under the "Why Agent Canvas" section in the overview. This consolidates the value prop and visual previews into one place.
Changes
first-time-setup.mdxdocs.jsonnavigation<Tabs>with setup step images tooverview.mdxThis PR was created by an AI agent (OpenHands) on behalf of the user.
@malhotra5 can click here to continue refining the PR