sidebars.ts 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
  2. const sidebars: SidebarsConfig = {
  3. apiSidebar: [require("./modules/python/sidebar.json")],
  4. docsSidebar: [
  5. {
  6. type: 'doc',
  7. label: 'Getting Started',
  8. id: 'usage/getting-started',
  9. },
  10. {
  11. type: 'category',
  12. label: 'Usage Methods',
  13. items: [
  14. {
  15. type: 'doc',
  16. label: 'CLI Mode',
  17. id: 'usage/how-to/cli-mode',
  18. },
  19. {
  20. type: 'doc',
  21. label: 'Headless Mode',
  22. id: 'usage/how-to/headless-mode',
  23. },
  24. {
  25. type: 'doc',
  26. label: 'Github Actions',
  27. id: 'usage/how-to/github-action',
  28. },
  29. {
  30. type: 'doc',
  31. label: 'Prompting Best Practices',
  32. id: 'usage/prompting-best-practices',
  33. },
  34. ],
  35. },
  36. {
  37. type: 'category',
  38. label: 'Advanced Configuration',
  39. items: [
  40. {
  41. type: 'category',
  42. label: 'LLM Configuration',
  43. items: [
  44. {
  45. type: 'doc',
  46. label: 'Overview',
  47. id: 'usage/llms/llms',
  48. },
  49. {
  50. type: 'category',
  51. label: 'Providers',
  52. items: [
  53. {
  54. type: 'doc',
  55. label: 'Azure',
  56. id: 'usage/llms/azure-llms',
  57. },
  58. {
  59. type: 'doc',
  60. label: 'Google',
  61. id: 'usage/llms/google-llms',
  62. },
  63. {
  64. type: 'doc',
  65. label: 'Groq',
  66. id: 'usage/llms/groq',
  67. },
  68. {
  69. type: 'doc',
  70. label: 'OpenAI',
  71. id: 'usage/llms/openai-llms',
  72. },
  73. {
  74. type: 'doc',
  75. label: 'OpenRouter',
  76. id: 'usage/llms/openrouter',
  77. },
  78. ],
  79. },
  80. ],
  81. },
  82. {
  83. type: 'doc',
  84. label: 'Custom Sandbox',
  85. id: 'usage/how-to/custom-sandbox-guide',
  86. },
  87. ],
  88. },
  89. {
  90. type: 'doc',
  91. label: 'Troubleshooting',
  92. id: 'usage/troubleshooting/troubleshooting',
  93. },
  94. {
  95. type: 'doc',
  96. label: 'Feedback',
  97. id: 'usage/feedback',
  98. },
  99. {
  100. type: 'category',
  101. label: 'For OpenHands Developers',
  102. items: [
  103. {
  104. type: 'category',
  105. label: 'Architecture',
  106. items: [
  107. {
  108. type: 'doc',
  109. label: 'Backend',
  110. id: 'usage/architecture/backend',
  111. },
  112. {
  113. type: 'doc',
  114. label: 'Runtime',
  115. id: 'usage/architecture/runtime',
  116. },
  117. ],
  118. },
  119. {
  120. type: 'doc',
  121. label: 'Debugging',
  122. id: 'usage/how-to/debugging',
  123. },
  124. {
  125. type: 'doc',
  126. label: 'Evaluation',
  127. id: 'usage/how-to/evaluation-harness',
  128. },
  129. {
  130. type: 'doc',
  131. label: 'Kubernetes Deployment',
  132. id: 'usage/how-to/openshift-example',
  133. },
  134. ],
  135. },
  136. {
  137. type: 'doc',
  138. label: 'About',
  139. id: 'usage/about',
  140. }
  141. ],
  142. };
  143. export default sidebars;