:wave: Hey All
Just want to flag that I'm doing a ...
# proj-documentationg
gentle-apple-32922
11/14/2025, 10:55 PM👋 Hey All
Just want to flag that I'm doing a deep dive into our docs. Revisions are planned to make this a better experience for everyone. I am going through the above thread, but I want to put it on our radar now. Please DM or reply in thread with feedback you have. I can't promise I can implement everyones request but will do my best.
c
calm-artist-7206
11/14/2025, 11:02 PMI feel there are unanswered issues there, though.
To clarify a bit, we have two major ways to rewrite docs:
• use separate tabs, like we do for SDK, for the Cloud
• use all three, CLI, App, Cloud in the same tab
Three is a bit much, so maybe it's not easy. Moreover, I'll note that over-centralization can make a mess.
The second has, at its turn, two major ways too, outlined by mamoodi here: https://openhands-ai.slack.com/archives/C08CR9XRQ3W/p1762810906373649?thread_ts=1762809202.189469&cid=C08CR9XRQ3W
calm-artist-7206
11/14/2025, 11:22 PMI look at the current docs site and honestly it feels messy, too much stuff of different ways of running OH meshed together.
I'm not sure, but I doubt that it's the same with code blocks where you choose a language or the other. I could be wrong though! I'm just thinking that maybe too much material is actually different on Cloud than OH
I'd still recommend that the Cloud gets its own tab or be otherwise separate. It may mean some redundancy, but we are making an agent, aren't we? 😅 Maaaybe the agent can take up some work of, e.g. inserting Cloud-specific stuff in a .mdx that is otherwise the same with OH .mdx?
In any case, I just feel it's worth to be food for thought. Thank you for this!
b
better-park-34863
11/15/2025, 12:31 AMWhat Engel said essentially. There’s multiple ways to run OH.
If you do it by use-case(i.e I want to do X), then you need to lay out how to do that in each way of running OH.
Engel’s suggestion of separating based on main tabs on the documentation is definitely worth thinking about. Each way of running OH gets its own story and you can easily split it by use case. That way if I’m using GUI local or CLI or cloud, I just go to that main tab and look for my use case. This will definitely have some duplication. But it gives simplicity and cleaner docs overall.
ty 1
g
gentle-apple-32922
11/15/2025, 2:24 PMTo clarify a bit, we have two major ways to rewrite docs:
• use separate tabs, like we do for SDK, for the Cloud
• use all three, CLI, App, Cloud in the same tabI am also researching adn looking for a solution here to @calm-artist-7206 i think it's clear we don't quite yet have a solid outline. This Docs revision is a part of a complete overhaul that includes the outline and structure
w
wooden-umbrella-84098
11/17/2025, 12:59 PM@gentle-apple-32922 I have a proposal for a simple restructuring here
https://allhandsai-restructure-navigation.mintlify.app/
https://github.com/OpenHands/docs/pull/108/files
This just moves pages around into something that makes more sense (at least to me). Most importantly, it creates clear sections for each of our three product lines (CLI, Web, SDK)
Longer-term I think you'll be able to make much bigger improvements on flow, what's documented vs not, etc. But hoping we can get this in short-term (assuming folks think it's a net improvement over today)
ty 1
👀 1