Skip to content

Commit 7004c89

Browse files
authored
updated docs (#1025)
1 parent 441b797 commit 7004c89

File tree

1 file changed

+14
-28
lines changed

1 file changed

+14
-28
lines changed

docs/docs/FAQ.md

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Frequently Asked Questions (FAQ)
22

3-
<details>
4-
<summary><strong>What are the best models for bolt.diy?</strong></summary>
3+
## What are the best models for bolt.diy?
54

65
For the best experience with bolt.diy, we recommend using the following models:
76

@@ -12,10 +11,8 @@ For the best experience with bolt.diy, we recommend using the following models:
1211
- **Qwen 2.5 Coder 32b**: Best model for self-hosting with reasonable hardware requirements
1312

1413
**Note**: Models with less than 7b parameters typically lack the capability to properly interact with bolt!
15-
</details>
1614

17-
<details>
18-
<summary><strong>How do I get the best results with bolt.diy?</strong></summary>
15+
## How do I get the best results with bolt.diy?
1916

2017
- **Be specific about your stack**:
2118
Mention the frameworks or libraries you want to use (e.g., Astro, Tailwind, ShadCN) in your initial prompt. This ensures that bolt.diy scaffolds the project according to your preferences.
@@ -29,63 +26,52 @@ For the best experience with bolt.diy, we recommend using the following models:
2926
- **Batch simple instructions**:
3027
Combine simple tasks into a single prompt to save time and reduce API credit consumption. For example:
3128
*"Change the color scheme, add mobile responsiveness, and restart the dev server."*
32-
</details>
3329

34-
<details>
35-
<summary><strong>How do I contribute to bolt.diy?</strong></summary>
30+
## How do I contribute to bolt.diy?
3631

3732
Check out our [Contribution Guide](CONTRIBUTING.md) for more details on how to get involved!
38-
</details>
3933

40-
<details>
41-
<summary><strong>What are the future plans for bolt.diy?</strong></summary>
34+
## What are the future plans for bolt.diy?
4235

4336
Visit our [Roadmap](https://roadmap.sh/r/ottodev-roadmap-2ovzo) for the latest updates.
4437
New features and improvements are on the way!
45-
</details>
4638

47-
<details>
48-
<summary><strong>Why are there so many open issues/pull requests?</strong></summary>
39+
## Why are there so many open issues/pull requests?
4940

5041
bolt.diy began as a small showcase project on @ColeMedin's YouTube channel to explore editing open-source projects with local LLMs. However, it quickly grew into a massive community effort!
5142

5243
We're forming a team of maintainers to manage demand and streamline issue resolution. The maintainers are rockstars, and we're also exploring partnerships to help the project thrive.
53-
</details>
5444

55-
<details>
56-
<summary><strong>How do local LLMs compare to larger models like Claude 3.5 Sonnet for bolt.diy?</strong></summary>
45+
## How do local LLMs compare to larger models like Claude 3.5 Sonnet for bolt.diy?
5746

5847
While local LLMs are improving rapidly, larger models like GPT-4o, Claude 3.5 Sonnet, and DeepSeek Coder V2 236b still offer the best results for complex applications. Our ongoing focus is to improve prompts, agents, and the platform to better support smaller local LLMs.
59-
</details>
6048

61-
<details>
62-
<summary><strong>Common Errors and Troubleshooting</strong></summary>
49+
## Common Errors and Troubleshooting
6350

64-
### **"There was an error processing this request"**
51+
### "There was an error processing this request"
6552
This generic error message means something went wrong. Check both:
6653
- The terminal (if you started the app with Docker or `pnpm`).
6754
- The developer console in your browser (press `F12` or right-click > *Inspect*, then go to the *Console* tab).
6855

69-
### **"x-api-key header missing"**
56+
### "x-api-key header missing"
7057
This error is sometimes resolved by restarting the Docker container.
7158
If that doesn't work, try switching from Docker to `pnpm` or vice versa. We're actively investigating this issue.
7259

73-
### **Blank preview when running the app**
60+
### Blank preview when running the app
7461
A blank preview often occurs due to hallucinated bad code or incorrect commands.
7562
To troubleshoot:
7663
- Check the developer console for errors.
7764
- Remember, previews are core functionality, so the app isn't broken! We're working on making these errors more transparent.
7865

79-
### **"Everything works, but the results are bad"**
66+
### "Everything works, but the results are bad"
8067
Local LLMs like Qwen-2.5-Coder are powerful for small applications but still experimental for larger projects. For better results, consider using larger models like GPT-4o, Claude 3.5 Sonnet, or DeepSeek Coder V2 236b.
8168

82-
### **"Received structured exception #0xc0000005: access violation"**
69+
### "Received structured exception #0xc0000005: access violation"
8370
If you are getting this, you are probably on Windows. The fix is generally to update the [Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170)
8471

85-
### **"Miniflare or Wrangler errors in Windows"**
72+
### "Miniflare or Wrangler errors in Windows"
8673
You will need to make sure you have the latest version of Visual Studio C++ installed (14.40.33816), more information here https://github.com/stackblitz-labs/bolt.diy/issues/19.
87-
</details>
8874

8975
---
9076

91-
Got more questions? Feel free to reach out or open an issue in our GitHub repo!
77+
Got more questions? Feel free to reach out or open an issue in our GitHub repo!

0 commit comments

Comments
 (0)