Commit Graph

39 Commits

Author SHA1 Message Date
Magnus Müller
ddb5c58170 Fix missing newline at end of docs.json file 2025-09-07 18:32:14 -07:00
Magnus Müller
fad088048e Update docs 2025-09-07 18:27:30 -07:00
Magnus Müller
1892888ca0 Fix JSON formatting in documentation file by adding a newline at the end of docs.json. This ensures proper file termination and adheres to best practices for JSON files. 2025-09-06 15:15:11 -07:00
Magnus Müller
73fa4b56db Add Playwright integration example to documentation
This commit adds a new example demonstrating the integration of Playwright with Browser-Use, showcasing how to utilize Playwright for form filling, taking screenshots, and extracting text. The example is linked in the documentation and includes installation instructions and a comprehensive code sample.

- **New Documentation**
- Added a new Playwright integration example in `playwright-integration.mdx`.
- Updated `docs.json` to include the new example in the documentation index.
- Enhanced the `add.mdx` file with references to the Playwright integration example.

This enhances the usability of Browser-Use by providing clear guidance on leveraging Playwright's capabilities alongside it.
2025-09-06 15:13:52 -07:00
Magnus Müller
f06a021b66 linter 2025-09-04 08:47:29 -07:00
Magnus Müller
2a3666d23a Add redirect for old hooks link 2025-09-04 08:43:15 -07:00
Magnus Müller
97f321bcea update error message for scroll 2025-09-02 11:32:03 -07:00
Magnus Müller
ead6a1a385 move guide location 2025-09-02 11:01:04 -07:00
Magnus Müller
4a0e9fe590 prompt guide 2025-09-02 10:58:49 -07:00
Gregor Žunič
deea516d21 removed cloud docs 2025-09-02 08:51:58 -07:00
Magnus Müller
471a8d399a Linter 2025-09-01 23:40:21 -07:00
Magnus Müller
c57ca023aa Refactor documentation structure and add new sections
- Reformatted JSON structure in `docs.json` for better readability.
- Updated navigation paths for development-related documentation.
- Removed outdated `hooks.mdx` and `mcp-client.mdx` files.
- Added new `get-help.mdx`, `local-setup.mdx`, `contribution-guide.mdx`, and `observability.mdx` files to enhance developer resources.
- Introduced `telemetry.mdx` to clarify data collection practices and opt-out options.
- Updated `mcp-server.mdx` to reflect current capabilities and usage instructions.
2025-09-01 23:36:19 -07:00
Gregor Žunič
d6ea63e431 reverted docs to API V1 2025-08-28 19:25:52 -07:00
Gregor Žunič
6b7b7d5c1e 301 redirects for the docs 2025-08-26 18:30:54 -07:00
Magnus Müller
2a27d8c1bf reorder docs files 2025-08-26 10:29:16 -07:00
Magnus Müller
b235e7bfe5 Add new tools documentation and enhance existing sections
- Introduced new documentation for "Available Tools" and "Remove Tools" to provide users with comprehensive guidance on tool management.
- Updated the "Basics" section to clarify the description of tools and included examples for better understanding.
- Enhanced the "Add Tools" section with additional examples to illustrate tool registration and usage.
- Improved the "Response" section by refining examples and clarifying the properties of `ActionResult` for better user comprehension.
2025-08-26 10:08:15 -07:00
Magnus Müller
264090e86b Simplify basics 2025-08-26 06:59:39 -07:00
Magnus Müller
6d31af92df Icons 2025-08-25 23:28:34 -07:00
Magnus Müller
fd5482d9cc Enhance documentation and examples for browser customization
- Rearranged pages in the documentation for better organization.
- Updated icons and descriptions in `browser-basic` and `chain-agents` sections for clarity.
- Added new sections for "Secure Setup" and "More Examples" to provide comprehensive guidance on advanced use cases.
- Improved the `fast-agent` example with clearer speed optimization instructions.
- Refined the `browser-real-browser` documentation to simplify the connection description.
2025-08-25 23:24:47 -07:00
Magnus Müller
dc5d06d760 More examples 2025-08-25 23:14:17 -07:00
Magnus Müller
483c824e80 Update documentation for browser customization
- Added new section for "Multiple Browser Instances" with example code for running agents in parallel using separate browser instances.
- Updated "Keep Open" documentation to reflect changes in task execution, simplifying the agent run process.
- Revised "Real Browser" documentation to clarify connection methods and updated example code for better usability.
- Removed outdated content from "Remote Browsers" section to streamline information and improve clarity.
2025-08-25 21:59:50 -07:00
Magnus Müller
505a103aa3 Browser import works 2025-08-25 21:16:30 -07:00
Magnus Müller
3ef2d83c12 browser docs 2025-08-25 20:11:31 -07:00
Magnus Müller
4150f02396 Dropdown for agent 2025-08-25 10:48:38 -07:00
Magnus Müller
fab4ad5833 wide mode for docs 2025-08-25 09:46:13 -07:00
Magnus Müller
0c096a65e2 Quickstart for llms 2025-08-25 01:40:51 -07:00
Magnus Müller
68ed8f1650 LLM docs 2025-08-25 01:18:21 -07:00
Magnus Müller
5a85f45f51 Remove cli because its not working and less than 0.2% use it currently with avg of 5 runs and 30 users per day 2025-08-24 19:53:24 -07:00
Gregor Žunič
787a041f00 SDK docs support, much nicer cloud docs, tiny bugfixes in docs 2025-08-22 00:18:53 -07:00
Gregor Žunič
3d22415190 switch to posthog analytics 2025-08-21 16:41:23 -07:00
Gregor Žunič
fd31e90abc better cloud docs + optimized docs images 2025-08-18 20:38:27 -07:00
Gregor Žunič
7d785385b8 much nicer intro + better cloud conversions 2025-08-18 17:22:25 -07:00
Gregor Žunič
b992d20ffc started rewriting docs 2025-08-07 18:48:44 -07:00
Saurav Panda
6363b74afb docs: added n8n workflow example 2025-08-05 22:34:01 -07:00
Mert Unsal
23c5a2fc4b update docs (#2545)
<!-- This is an auto-generated description by cubic. -->

## Summary by cubic
Added documentation and Python examples for the new Search API,
including guides and usage for the simple-search and search-url
endpoints.

- **Docs**
- Added detailed API reference pages for simple-search and search-url
endpoints.
- Added a quickstart guide and usage examples in Python, JavaScript, and
cURL.
  - Updated docs navigation to include the new Search API section.
- Added example scripts for both endpoints in the examples/search
directory.

<!-- End of auto-generated description by cubic. -->
2025-07-26 21:59:19 +02:00
mertunsall
2c5c74cab2 new docs for search API and examples 2025-07-26 21:42:48 +02:00
LarsenCundric
def771e893 Make separate tab for cloud sdk in docs 2025-07-24 20:32:35 +02:00
LarsenCundric
b019c7984f Add docs 2025-07-24 10:36:56 +02:00
Saurav Panda
e0add9ce8f Updated API docs and moved to newer mintlify version 2025-07-11 18:02:40 -07:00