Review new docs and navigation outline

[jpelletier1]

Summary

This issue tracks the review of documentation pages for a new docs outline:

Preview URL: https://allhandsai-jp-docs-restructure-0129.mintlify.app/overview/introduction

1. Pages with TODO- prefix - These pages have been marked with a TODO- prefix in their titles, indicating they need review or completion.
2. Use Case pages - All pages in the use-cases section should be reviewed for accuracy, completeness, and quality.

Pages with TODO- Prefix (#295)

The following pages have titles prefixed with TODO- and need to be reviewed:

Page	Path
TODO-OpenHands in Your SDLC	openhands/usage/essential-guidelines/sdlc-integration.mdx
TODO-When to Use OpenHands	openhands/usage/essential-guidelines/when-to-use-openhands.mdx
TODO-Good vs. Bad Instructions	openhands/usage/essential-guidelines/good-vs-bad-instructions.mdx

Use Case Pages

All Use Case pages should be reviewed for quality and completeness:

Use Case	Path
COBOL Modernization #296	openhands/usage/use-cases/cobol-modernization.mdx
Code Review #297	openhands/usage/use-cases/code-review.mdx
Dependency Upgrades #298	openhands/usage/use-cases/dependency-upgrades.mdx
Incident Triage #299	openhands/usage/use-cases/incident-triage.mdx
Spark Migrations #300	openhands/usage/use-cases/spark-migrations.mdx
Vulnerability Remediation #301	openhands/usage/use-cases/vulnerability-remediation.mdx

Review Tasks

• Review each TODO- prefixed page and either complete it or remove the TODO- prefix
• Ensure all Use Case pages have consistent structure and formatting
• Verify all Use Case pages have accurate and up-to-date information
• Check that code examples in Use Case pages are correct and functional
• Update navigation in docs.json if any pages are renamed or removed

Notes

• Pages marked with TODO- prefix appear in both the Essential Guidelines and Use Cases sections
• Two Use Case pages (spark-migrations.mdx and code-review.mdx) also have the TODO- prefix

[jpelletier1]

@OpenHands Please create a single sub-issue that's scope is to review the pages identified under "Pages with TODO- Prefix". Then update this issue with a link to that sub-issue.

[openhands-ai]

I'm on it! jpelletier1 can track my progress at all-hands.dev

[jpelletier1]

Created sub-issue #295 to track the review of pages with TODO- prefix:

• Issue: Review pages with TODO- prefix #295 - Review pages with TODO- prefix
• Scope: Review the 3 pages identified under "Pages with TODO- Prefix" section

Page	Path
TODO-OpenHands in Your SDLC	openhands/usage/essential-guidelines/sdlc-integration.mdx
TODO-When to Use OpenHands	openhands/usage/essential-guidelines/when-to-use-openhands.mdx
TODO-Good vs. Bad Instructions	openhands/usage/essential-guidelines/good-vs-bad-instructions.mdx

[openhands-ai]

I have completed the requested tasks:

Summary

✅ Created Sub-Issue #295

• Title: "Review pages with TODO- prefix"
• URL: Review pages with TODO- prefix #295
• Scope: Review the 3 pages identified under "Pages with TODO- Prefix" section:
  • openhands/usage/essential-guidelines/sdlc-integration.mdx (TODO-OpenHands in Your SDLC)
  • openhands/usage/essential-guidelines/when-to-use-openhands.mdx (TODO-When to Use OpenHands)
  • openhands/usage/essential-guidelines/good-vs-bad-instructions.mdx (TODO-Good vs. Bad Instructions)

✅ Updated Parent Issue #294

• Added a comment to issue Review new docs and navigation outline #294 with a link to the new sub-issue Review pages with TODO- prefix #295
• The comment includes the scope and the list of pages to be reviewed

No code changes were made to the repository, so no branch or PR is needed. This task only involved creating GitHub issues and comments via the API.

View full conversation

[jpelletier1]

@OpenHands for each of the pages listed under "Use Cases Pages", create a single sub-issue for each one. The parent issue for each of these should be the current ticket.

[openhands-ai]

I'm on it! jpelletier1 can track my progress at all-hands.dev