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

[Documentation]: config.toml options should be documented on the doc web site #3325

Closed
neubig opened this issue Aug 9, 2024 · 9 comments · Fixed by #5004
Closed

[Documentation]: config.toml options should be documented on the doc web site #3325

neubig opened this issue Aug 9, 2024 · 9 comments · Fixed by #5004
Assignees
Labels
documentation Related to documentation enhancement New feature or request fix-me Attempt to fix this issue with OpenHands good first issue Good for newcomers
Milestone

Comments

@neubig
Copy link
Contributor

neubig commented Aug 9, 2024

What problem or use case are you trying to solve?

It seems that there is no documentation on all the options available to configure OpenDevin on the documentation web site: https://github.com/All-Hands-AI/OpenHands/tree/main/docs

Describe the UX of the solution you'd like

It would be ideal if we could get some documentation on the web site.

Do you have thoughts on the technical implementation?

This should be created as its own page, and also added to the appropriate place in sidebars.ts: https://github.com/All-Hands-AI/OpenHands/blob/main/docs/sidebars.ts

To figure out what configuration options are available, we can look at the following file:

class ConfigType(str, Enum):

@neubig neubig added documentation Related to documentation enhancement New feature or request good first issue Good for newcomers labels Aug 9, 2024
@mamoodi
Copy link
Collaborator

mamoodi commented Aug 9, 2024

The template is helpful: https://github.com/OpenDevin/OpenDevin/blob/main/config.template.toml

I agree though, there's a lot of configs that can be changed and we need some source of truth for those configs.

Copy link
Contributor

github-actions bot commented Sep 9, 2024

This issue is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@github-actions github-actions bot added the Stale Inactive for 30 days label Sep 9, 2024
Copy link
Contributor

This issue was closed because it has been stalled for over 30 days with no activity.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Sep 17, 2024
@neubig neubig reopened this Sep 17, 2024
@github-actions github-actions bot removed the Stale Inactive for 30 days label Sep 18, 2024
@neubig neubig added the fix-me Attempt to fix this issue with OpenHands label 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-3325' has been created with the attempted changes. You can view the branch here. Manual intervention may be required.

@JanumalaAkhilendra
Copy link

i want to work on this issue , if it is still open , please assign it to me .
Thank you :)

@neubig neubig self-assigned this Oct 8, 2024
@neubig neubig added this to the 2024-10 milestone Oct 8, 2024
@neubig
Copy link
Contributor Author

neubig commented Oct 8, 2024

Hey @JanumalaAkhilendra , ok, thanks!

@neubig neubig assigned JanumalaAkhilendra and unassigned neubig Oct 8, 2024
Copy link
Contributor

This issue is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@github-actions github-actions bot added the Stale Inactive for 30 days label Nov 10, 2024
@Mr-Imperium
Copy link
Contributor

Working on it.

Mr-Imperium added a commit to Mr-Imperium/OpenHands that referenced this issue Nov 14, 2024
Added a configuration options md file to openhands/docs. Added appropriately to sidebars.ts.
Fixes All-Hands-AI#3325
@Mr-Imperium Mr-Imperium mentioned this issue Nov 14, 2024
1 task
@github-actions github-actions bot removed the Stale Inactive for 30 days label Nov 16, 2024
enyst added a commit that referenced this issue Nov 26, 2024
Co-authored-by: Engel Nyst <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation enhancement New feature or request fix-me Attempt to fix this issue with OpenHands good first issue Good for newcomers
Projects
None yet
4 participants