search

sweepai / sweep

Sweep: open-source AI-powered Software Developer for small features and bug fixes.
https://sweep.dev
Other
7.41k stars 422 forks source link

Sweep: Fix the documentation in docs/pages/deployment.mdx #3723

Open wwzeng1 opened 4 months ago

wwzeng1 commented 4 months ago

Details

Step 4 of the cloud development "update webhook URL" needs to be step 5 for the local instructions, updated with the ngrok URL

Branch

No response

Checklist - [X] Modify `docs/pages/deployment.mdx` ✓ https://github.com/sweepai/sweep/commit/b87f2138b928c8a10877c293025269a133e2b283 [Edit](https://github.com/sweepai/sweep/edit/sweep/fix_the_documentation_in_docspagesdeploy/docs/pages/deployment.mdx)
sweep-nightly[bot] commented 4 months ago

🚀 Here's the PR! #3725

See Sweep's progress at the progress dashboard!
💎 Sweep Pro: I'm using GPT-4. You have unlimited GPT-4 tickets. (tracking ID: 119948063f)

[!TIP] I can email you next time I complete a pull request if you set up your email here!

Actions (click)

Step 1: 🔎 Searching

I found the following snippets in your repository. I will now analyze these snippets and come up with a plan.

Some code snippets I think are relevant in decreasing order of relevance (click to expand). If some file is missing from here, you can mention the path in the ticket description. https://github.com/sweepai/sweep/blob/d8944425cd46608d177419d6d189df1ce719b28a/docs/pages/deployment.mdx#L1-L181

Step 2: ⌨️ Coding

Update the and blocks to match the actual code in the file and include the necessary changes.

#### 4. Set up the Reverse Proxy We're going to use [Ngrok](https://ngrok.com/) for a reverse proxy. Sign up for an Ngrok account and install the CLI from https://dashboard.ngrok.com/signup. Your terminal must be in the same directory as your ngrok installation. Start the reverse proxy with `ngrok http 8080`. The second last line should say something like ```sh filename="terminal" Forwarding https://4d8d8bf053be.ngrok.app -> http://localhost:8080 ``` Then proceed with step 4. --- ### You have successfully deployed Sweep! *For enterprise support such as fine-tuning (20% performance gain), search index caching, usage tracking, and progress dashboards please contact team@sweep.dev.* **Creating a Pull Request with Sweep** Use Sweep by creating a new issue on the repository with a title prefixed with `Sweep:` like `Sweep: add type hints to BaseIndex.tsx`. For more details see [how to use Sweep](https://docs.sweep.dev/#-how-to-use-sweep). #### 4. Set up the Reverse Proxy We're going to use [Ngrok](https://ngrok.com/) for a reverse proxy. Sign up for an Ngrok account and install the CLI from https://dashboard.ngrok.com/signup. Your terminal must be in the same directory as your ngrok installation. Start the reverse proxy with `ngrok http 8080`. The second last line should say something like ```sh filename="terminal" Forwarding https://4d8d8bf053be.ngrok.app -> http://localhost:8080 ``` #### 5. Update the GitHub Webhook URL Copy the forwarding URL from the ngrok output in step 4, for example: ``` https://4d8d8bf053be.ngrok.app ``` Go to your GitHub app and update the `Webhook URL` to the ngrok forwarding URL. For user accounts: ```txt /GITHUB_BOT_USERNAME/ https://github.com/settings/apps/GITHUB_BOT_USERNAME ``` For organizations: ```txt /GITHUB_BOT_USERNAME/, /YOUR_ORGANIZATION/ https://github.com/YOUR_ORGANIZATION/sweepai/settings/apps/GITHUB_BOT_USERNAME ``` --- ### You have successfully deployed Sweep! *For enterprise support such as fine-tuning (20% performance gain), search index caching, usage tracking, and progress dashboards please contact team@sweep.dev.* **Creating a Pull Request with Sweep** Use Sweep by creating a new issue on the repository with a title prefixed with `Sweep:` like `Sweep: add type hints to BaseIndex.tsx`. For more details see [how to use Sweep](https://docs.sweep.dev/#-how-to-use-sweep).

Step 3: 🔁 Code Review

I have finished reviewing the code for completeness. I did not find errors for sweep/fix_the_documentation_in_docspagesdeploy.

🎉 Latest improvements to Sweep:
  • New dashboard launched for real-time tracking of Sweep issues, covering all stages from search to coding.
  • Integration of OpenAI's latest Assistant API for more efficient and reliable code planning and editing, improving speed by 3x.
  • Use the GitHub issues extension for creating Sweep issues directly from your editor.

💡 To recreate the pull request edit the issue title or description. Something wrong? Let us know.

This is an automated message generated by Sweep AI.