update-local-dev-docs #2914
Merged
update-local-dev-docs #2914
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Agent Task Evaluation Results: 3/3 (100%)View detailed results
Check the evaluate-tasks job for detailed task execution logs. |
| cd browser-use | ||
| uv sync --all-extras --dev | ||
| # or pip install -U git+https://github.com/browser-use/browser-use.git@main | ||
| - This space is moving fast. We have 10 ideas daily. Lets exchange some. |
There was a problem hiding this comment.
Use the contraction "Let's" and remove the trailing whitespace at the end of the line.
(Based on your team's feedback about matching the project's indentation style (tabs, not spaces), the fix avoids stray trailing spaces.)
Prompt for AI agents
Address the following comment on docs/development/contribution-guide.mdx at line 18:
<comment>Use the contraction "Let's" and remove the trailing whitespace at the end of the line.
(Based on your team's feedback about matching the project's indentation style (tabs, not spaces), the fix avoids stray trailing spaces.)</comment>
<file context>
@@ -5,68 +5,35 @@ icon: "github"
-cd browser-use
-uv sync --all-extras --dev
-# or pip install -U git+https://github.com/browser-use/browser-use.git@main
+- This space is moving fast. We have 10 ideas daily. Lets exchange some.
+- Browse our [GitHub Issues](https://github.com/browser-use/browser-use/issues)
+- Check out our most active issues on [Discord](https://discord.gg/zXJJHtJf3k)
</file context>
Suggested change
| - This space is moving fast. We have 10 ideas daily. Lets exchange some. | |
| - This space is moving fast. We have 10 ideas daily. Let's exchange some. |
.env.example
Outdated
| # OPENAI_API_KEY=your_openai_api_key_here | ||
| # ANTHROPIC_API_KEY=your_anthropic_api_key_here | ||
| # AZURE_OPENAI_API_KEY= | ||
| # AZURE_ENDPOINT= |
There was a problem hiding this comment.
Misnamed environment variable: use AZURE_OPENAI_ENDPOINT instead of AZURE_ENDPOINT to match code and docs; otherwise Azure config won’t be read.
Prompt for AI agents
Address the following comment on .env.example at line 37:
<comment>Misnamed environment variable: use AZURE_OPENAI_ENDPOINT instead of AZURE_ENDPOINT to match code and docs; otherwise Azure config won’t be read.</comment>
<file context>
@@ -33,6 +33,12 @@ ANONYMIZED_TELEMETRY=true
# OPENAI_API_KEY=your_openai_api_key_here
# ANTHROPIC_API_KEY=your_anthropic_api_key_here
+# AZURE_OPENAI_API_KEY=
+# AZURE_ENDPOINT=
+# GOOGLE_API_KEY=
+# DEEPSEEK_API_KEY=
</file context>
Suggested change
| # AZURE_ENDPOINT= | |
| # AZURE_OPENAI_ENDPOINT= |
docs/development/local-setup.mdx
Outdated
| NOVITA_API_KEY= | ||
| BROWSER_USE_LOGGING_LEVEL=debug # Helpful for development | ||
| # set logging level | ||
| echo "BROWSER_USE_LOGGING_LEVEL=debug" >> .env |
There was a problem hiding this comment.
Appending BROWSER_USE_LOGGING_LEVEL after copying .env.example duplicates the key; replace in-place if present, append otherwise for an idempotent setup.
Prompt for AI agents
Address the following comment on docs/development/local-setup.mdx at line 27:
<comment>Appending BROWSER_USE_LOGGING_LEVEL after copying .env.example duplicates the key; replace in-place if present, append otherwise for an idempotent setup.</comment>
<file context>
@@ -78,83 +22,38 @@ Set up your environment variables:
-NOVITA_API_KEY=
-BROWSER_USE_LOGGING_LEVEL=debug # Helpful for development
+# set logging level
+echo "BROWSER_USE_LOGGING_LEVEL=debug" >> .env
</file context>
</details>
```suggestion
if grep -q "^BROWSER_USE_LOGGING_LEVEL=" .env; then sed -i.bak "s/^BROWSER_USE_LOGGING_LEVEL=.*/BROWSER_USE_LOGGING_LEVEL=debug/" .env; else echo "BROWSER_USE_LOGGING_LEVEL=debug" >> .env; fi
- 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.
- Changed `AZURE_ENDPOINT` to `AZURE_OPENAI_ENDPOINT` in `.env.example`. - Corrected a typo in the contribution guide from "Lets" to "Let's". - Commented out the logging level setting in `local-setup.mdx` for clarity.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Auto-generated PR for: update-local-dev-docs
Summary by cubic
Streamlined local development and contribution docs to make onboarding faster and clearer. Added more LLM provider keys to .env.example and corrected the LLM quickstart token count.