Repository: All-Hands-AI/OpenHands
Pull request: Fix issue #4136: 'Restructuring documentation'
- [x] Include this change in the Release Notes. If checked, you must provide an **end-user friendly** description for your change below

**End-user friendly description of the problem this fixes or functionality that this introduces**
Restructure documentation to be in an easier-to-follow format

---
**Give a summary of what the PR does, explaining any non-trivial design decisions**
Mostly self-explanatory, see #4136 for details

---
**Link of any specific issues this addresses**
Fixes #4136

Problem statement:
Restructuring documentation
**What problem or use case are you trying to solve?**

It would be best to restructure the OpenHands documentation to make it a bit easier to parse.
This can mostly be done by reordering `sidebars.ts` for now, without changing content.

**Proposal**

Here is a proposal of top-level and second-level menus:

* Getting Started
* Usage Methods
  * CLI Mode
  * Headless Mode
  * Github Actions
* Advanced Configuration
  * LLM Configuration (previously "LLMs")
  * Custom Sandbox
* Troubleshooting
* Feedback
* For OpenHands Developers
  * Architecture
  * Debugging
  * Evaluation
  * Kubernetes Deployment (previously "Kubernetes")
* About

Hints from issue discussion:
OpenHands started fixing the issue! You can monitor the progress [here](https://github.com/All-Hands-AI/OpenHands/actions/runs/11127545316).
An attempt was made to automatically fix this issue, but it was unsuccessful. A branch named 'openhands-fix-issue-4136' has been created with the attempted changes. You can view the branch [here](https://github.com/All-Hands-AI/OpenHands/tree/openhands-fix-issue-4136). Manual intervention may be required.

Commit message: Remove github actions for now until #4124

Patch to review:
diff --git a/docs/sidebars.ts b/docs/sidebars.ts
index 3b4810efe019..2a4420092b62 100644
--- a/docs/sidebars.ts
+++ b/docs/sidebars.ts
@@ -10,17 +10,33 @@ const sidebars: SidebarsConfig = {
     },
     {
       type: 'category',
-      label: 'LLMs',
+      label: 'Usage Methods',
       items: [
         {
           type: 'doc',
-          label: 'Overview',
-          id: 'usage/llms/llms',
+          label: 'CLI Mode',
+          id: 'usage/how-to/cli-mode',
+        },
+        {
+          type: 'doc',
+          label: 'Headless Mode',
+          id: 'usage/how-to/headless-mode',
         },
+      ],
+    },
+    {
+      type: 'category',
+      label: 'Advanced Configuration',
+      items: [
         {
           type: 'category',
-          label: 'Providers',
+          label: 'LLM Configuration',
           items: [
+            {
+              type: 'doc',
+              label: 'Overview',
+              id: 'usage/llms/llms',
+            },
             {
               type: 'doc',
               label: 'Azure',
@@ -48,6 +64,11 @@ const sidebars: SidebarsConfig = {
             },
           ],
         },
+        {
+          type: 'doc',
+          label: 'Custom Sandbox',
+          id: 'usage/how-to/custom-sandbox-guide',
+        },
       ],
     },
     {
@@ -62,48 +83,28 @@ const sidebars: SidebarsConfig = {
     },
     {
       type: 'category',
-      label: 'How-to Guides',
+      label: 'For OpenHands Developers',
       items: [
         {
           type: 'doc',
-          id: 'usage/how-to/cli-mode',
-        },
-        {
-          type: 'doc',
-          id: 'usage/how-to/headless-mode',
+          label: 'Architecture',
+          id: 'usage/architecture/backend',
         },
         {
           type: 'doc',
-          id: 'usage/how-to/custom-sandbox-guide',
+          label: 'Debugging',
+          id: 'usage/how-to/debugging',
         },
         {
           type: 'doc',
+          label: 'Evaluation',
           id: 'usage/how-to/evaluation-harness',
         },
         {
           type: 'doc',
+          label: 'Kubernetes Deployment',
           id: 'usage/how-to/openshift-example',
         },
-        {
-          type: 'doc',
-          id: 'usage/how-to/debugging',
-        }
-      ]
-    },
-    {
-      type: 'category',
-      label: 'Architecture',
-      items: [
-        {
-          type: 'doc',
-          label: 'Backend',
-          id: 'usage/architecture/backend',
-        },
-        {
-          type: 'doc',
-          label: 'Runtime',
-          id: 'usage/architecture/runtime',
-        }
       ],
     },
     {


Code review comments:
diff_hunk: @@ -62,48 +83,28 @@ const sidebars: SidebarsConfig = {
     },
     {
       type: 'category',
-      label: 'How-to Guides',
+      label: 'For OpenHands Developers',
       items: [
         {
           type: 'doc',
-          id: 'usage/how-to/cli-mode',
-        },
-        {
-          type: 'doc',
-          id: 'usage/how-to/headless-mode',
+          label: 'Architecture',
+          id: 'usage/architecture/backend',
         },
         {
           type: 'doc',
-          id: 'usage/how-to/custom-sandbox-guide',
+          label: 'Debugging',
+          id: 'usage/how-to/debugging',
         },
         {
           type: 'doc',
+          label: 'Evaluation',
           id: 'usage/how-to/evaluation-harness',
         },
         {
           type: 'doc',
+          label: 'Kubernetes Deployment',
           id: 'usage/how-to/openshift-example',
         },
-        {
-          type: 'doc',
-          id: 'usage/how-to/debugging',
-        }
-      ]
-    },
-    {
-      type: 'category',
-      label: 'Architecture',
-      items: [
-        {
-          type: 'doc',
-          label: 'Backend',
-          id: 'usage/architecture/backend',
-        },
-        {
-          type: 'doc',
-          label: 'Runtime',
-          id: 'usage/architecture/runtime',
path: docs/sidebars.ts
text: @user1:
Isn't the runtime an important part to keep included?