Skip to content

Conversation

@jpelletier1
Copy link
Contributor

@jpelletier1 jpelletier1 commented Jan 30, 2026

This is an initial layout that roughly mimics Devin docs. It attempts to separate Documentation and Use Cases.

Some background:

  • The structure attempts to provide better onboarding docs and "first time user experience" docs.
    • This initial pass is mostly a mapping of existing content; there are some pages we may want to design
    • Features that are common across all interfaces (like Skills, MCP, Secrets, etc.) have their own standalone pages
  • The OSS projects have some additional sections dedicated for them
    • Local GUI docs can be found under Documentation > Additional Docs > Local GUI
    • CLI docs also have their own section under Documentation > CLI
    • SDK remains its own tab, unchanged
  • OpenHands Cloud can be found under Product Guides > OpenHands Cloud. There's more opportunity to build this out.

TODO:

  • Pages marked TODO- are stubbed out but need more content

  • Content is needed under the "Use Cases" tab

  • Redesign the "Quick Start" page

  • I have read and reviewed the documentation changes to the best of my ability.

  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

This is an initial layout that roughly mimics Devin docs. It attempts to separate Documentation and Use Cases.
@jpelletier1 jpelletier1 requested a review from mamoodi as a code owner January 30, 2026 01:20
@jpelletier1 jpelletier1 marked this pull request as draft January 30, 2026 01:20
@jpelletier1 jpelletier1 changed the title Initial layout of new doc structure DRAFT - Work in Process - Initial layout of new doc structure Jan 30, 2026
- incident-triage.mdx: Add content based on Datadog debugging blog post
  - Features automated error analysis with OpenHands SDK
  - Includes GitHub Actions workflow for Datadog integration
  - Links to blog: https://openhands.dev/blog/debugging-production-issues-with-ai-agents-automating-datadog-error-analysis

- cobol-modernization.mdx: Add content based on COBOL-to-Java refactoring blog post
  - Features iterative refinement approach with multiple agents
  - Includes code transformation examples (COBOL to Java)
  - Links to blog: https://openhands.dev/blog/20251218-cobol-to-java-refactoring

- vulnerability-remediation.mdx: Add content based on vulnerability fixer documentation
  - Explains automated vulnerability remediation with AI agents
  - Links to example implementation at github.com/OpenHands/vulnerability-fixer
  - Covers integration with security scanners (Snyk, Dependabot, CodeQL)

- dependency-upgrades.mdx: Remove redundant security scanning section
  - Links to Vulnerability Remediation page for security-related upgrades
  - Focuses on general dependency upgrade workflows

Co-authored-by: openhands <openhands@all-hands.dev>
- Rename from 'TODO-Tutorial Library' to 'Tutorial Library'
- Remove 'Getting Started with Tutorials' section
- Add Note linking to Use Cases section for in-depth guidance
- Add Code Review cross-references:
  - Link to Code Review Use Case page
  - Link to PR Review SDK Guide (sdk/guides/github-workflows/pr-review)
- Add Bug Fixing cross-reference to Incident Triage Use Case

Co-authored-by: openhands <openhands@all-hands.dev>
Replace tabs-based layout with a card-based design:
- OpenHands Cloud (recommended) - links to https://app.all-hands.dev
- Local GUI - links to /openhands/usage/run-openhands/local-setup
- Terminal / CLI - links to /openhands/usage/cli/installation

Each card includes relevant icons and bullet points highlighting key features.

Co-authored-by: openhands <openhands@all-hands.dev>
@openhands-ai
Copy link

openhands-ai bot commented Feb 5, 2026

Looks like there are a few issues preventing this PR from being merged!

  • GitHub Actions are failing:
    • Check Broken Links
    • .github/workflows/sync-agent-sdk-openapi.yml
    • .github/workflows/sync-docs-code-blocks.yml

If you'd like me to help, just leave a comment, like

@OpenHands please fix the failing actions on PR #284 at branch `jp/docs-restructure-0129`

Feel free to include any additional details that might help me get this PR into a better state.

You can manage your notification settings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Review new docs and navigation outline

2 participants