sweepai / sweep

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

Sweep: add anchors to all the blocks in the FAQ #3373

Closed kevinlu1248 closed 3 months ago

kevinlu1248 commented 3 months ago

Details

Make each block hyperlinkable.

Branch

No response

Checklist - [X] Modify `docs/pages/faq.mdx` ✓ https://github.com/sweepai/sweep/commit/421f6036ff0aa3f12d72eb3af235d066726dee81 [Edit](https://github.com/sweepai/sweep/edit/sweep/add_anchors_to_all_the_blocks_in_the_faq/docs/pages/faq.mdx) - [X] Running GitHub Actions for `docs/pages/faq.mdx` ✓ [Edit](https://github.com/sweepai/sweep/edit/sweep/add_anchors_to_all_the_blocks_in_the_faq/docs/pages/faq.mdx)
sweep-nightly[bot] commented 3 months ago

🚀 Here's the PR! #3374

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

[!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/05a753ee0f2331a22f70f497fd54b0191067c678/docs/pages/faq.mdx#L1-L147

Step 2: ⌨️ Coding

--- 
+++ 
@@ -1,6 +1,6 @@
 # Frequently Asked Questions

-
+
Does Sweep write tests? Yep! The easiest way to have Sweep write tests is by modifying the `description` parameter in your `sweep.yaml`. You can add something like: @@ -8,7 +8,7 @@
-
+
Can we trust the code written by Sweep? You should always review the PR. However, we also perform testing to make sure the PR works using your existing GitHub actions. @@ -16,21 +16,21 @@
-
+
Can I have Sweep work off of another branch besides main? Yes! In the `sweep.yaml`, you can set the `branch` parameter to something besides your default branch, and Sweep will use that as a reference.
-
+
How do I retry an issue with Sweep? To retry an issue, prefix your issue reply with 'Sweep: '. This will trigger Sweep to retry the issue.
-
+
Can I give documentation to Sweep? Yes! In the `sweep.yaml`, you can specify docs. Be sure to pick the prefix of the site, which will allow us to only fetch the docs you need. @@ -38,7 +38,7 @@
-
+
Can I comment on Sweep’s PRs? Yep! You have three options depending on the degree of the change: @@ -49,62 +49,62 @@
-
+
Why are you open source? We’re open source so that our users can see exactly how their data is processed, as well as learn from how Sweep works! We’re really excited about building a community of Sweep users(like you!).
-
+
What’s the difference from CoPilot? Copilot lives in your IDE and writes small chunks of code at a time. This takes ~3-5 seconds, and you need to watch it the entire time. Sweep runs completely asynchronously, and handles the task end to end. This might take 10-15 minutes, but you’re able to walk away and come back to a finished pull request. Copilot also doesn’t have access to the latest documentation.
-
+
What’s the difference from ChatGPT? ChatGPT can’t write the actual PR, and you’d have to paste the generated code into your codebase and create a PR yourself. ChatGPT doesn’t have access to your codebase and the latest documentation, so it’s limited with large software projects.
-
+
What’s the difference from AutoGPT? AutoGPT (and similar tools) doesn’t work, and Sweep works. We don’t allow the language model to perform open domain tool execution (which doesn’t work well). We perform a fixed flow of search → plan → write code → validate code, repeating the last two steps. This lets us reliably generate PRs corresponding to the user description.
-
+
What’s the difference from GPT-Engineer, Smol Developer and AutoGPT? Sweep is built to improve on an existing codebase, which is a more frequent and higher need, than generating boilerplate, which is mostly a solved problem since you can just fork existing boilerplates.
-
+
What’s the difference from Cody and Bloop? We do more than just chat-with-your-code by actually creating pull requests.
-
+
What’s the difference from AutoPR? We're shipping new features at Sweep everyday and unfortunately it looks like AutoPR hasn't received any updates in months.
-
+
Do you guys support GitLab / Gitea / BitBucket / Forgejo? We only support GitHub at the moment. We're currently focused on delivering more value and making Sweep more reliable and capable as opposed to supporting more services.
-
+
Do you guys support other models, such as GPT-3.5, Claude and Gemini as well as open-source models like Deepseek and CodeLlama? We currently only support GPT-4 but are actively testing on Claude v3 which is looking promising -- it's faster, less expensive and smarter with using the tool calls. Gemini also looks promising with long-context multi-file reasoning but we have tested on it less. We just moved off function calls for our code modification agent so this is now possible. @@ -119,28 +119,28 @@
-
+
Do you store our code? We access your GitHub repository at runtime. At the end of execution, your code is deleted from the server. To perform search over your codebase, we use the hashed contents along with the embeddings. This allows us to avoid storing any code as plaintext. Read more about it here: [https://docs.sweep.dev/blogs/search-infra](https://docs.sweep.dev/blogs/search-infra).
-
+
Do you have example Sweep PRs? Yes! Check out [https://docs.sweep.dev/about/examples](https://docs.sweep.dev/about/examples).
-
+
Do you support integration with Linear, Jira, Zendesk etc.? We don't directly support it but we recommend setting up a Zapier plugin that syncs GitHub issues from Linear/Jira. This will automatically create the GitHub issues when you make a Linear/Jira issue which will trigger Sweep if prefixed with "Sweep: ".
-
+
What does the 'Empty repository' error mean? The 'Empty repository' error occurs when the repository was just created and Sweep will not work. This is because Sweep needs some existing code in the repository to work with. If the repository is empty, Sweep does not have any code to analyze or modify. To fix this error, you can add some initial code to your repository before using Sweep. Once there is some code in the repository, Sweep should be able to work as expected.

Ran GitHub Actions for 421f6036ff0aa3f12d72eb3af235d066726dee81:
• Vercel Preview Comments:


Step 3: 🔁 Code Review

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


🎉 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.