browser-use
Proposal to Synchronize Documentation with Code Releases
Type of Documentation Issue
Other (specify in description)
Documentation Page
https://docs.browser-use.com/
Issue Description
As someone who regularly reviews issues, I've observed that deploying documentation directly from the main branch to the official site can lead to discrepancies between the documentation and the latest stable release, causing confusion among users. For instance, in Issue #843 and #576, users have reported encountering features in the documentation that are not yet available in the current release, leading to errors when attempting to implement code based on the documentation.
This suggests that the users reporting these issues are just a fraction of those affected; many others may abandon the project upon encountering such inconsistencies during their initial experience.
Suggested Changes
To address this issue, I propose the following:
-
Deploy Documentation Concurrently with Releases: Ensure that the documentation corresponding to each release is deployed to
docs.browser-use.comsimultaneously with the code release. This approach will maintain consistency between the code and its documentation, reducing user confusion and preventing implementation errors.
Implementing this change would allow users to access accurate documentation that aligns with the version they are using, thereby enhancing the overall user experience.
Thank you for considering this proposal.
