Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructuring documentation #4136

Closed
neubig opened this issue Oct 1, 2024 · 2 comments · Fixed by #4138
Closed

Restructuring documentation #4136

neubig opened this issue Oct 1, 2024 · 2 comments · Fixed by #4138
Labels
enhancement New feature or request fix-me Attempt to fix this issue with OpenHands

Comments

@neubig
Copy link
Contributor

neubig commented Oct 1, 2024

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
@neubig neubig added enhancement New feature or request fix-me Attempt to fix this issue with OpenHands labels Oct 1, 2024
Copy link
Contributor

github-actions bot commented Oct 1, 2024

OpenHands started fixing the issue! You can monitor the progress here.

Copy link
Contributor

github-actions bot commented Oct 1, 2024

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. Manual intervention may be required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request fix-me Attempt to fix this issue with OpenHands
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant