Skip to content

Commit d9b2801

Browse files
doc: mkdoc-docs-styled
mkdoc consistent style
2 parents 02621e3 + a053bfc commit d9b2801

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

docs/docs/CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,14 @@
88
- [Development Setup](#development-setup)
99
- [Deploymnt with Docker](#docker-deployment-documentation)
1010

11+
---
12+
1113
## Code of Conduct
1214

1315
This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
1416

17+
---
18+
1519
## How Can I Contribute?
1620

1721
### 🐞 Reporting Bugs and Feature Requests
@@ -29,6 +33,8 @@ This project and everyone participating in it is governed by our Code of Conduct
2933
### ✨ Becoming a Core Contributor
3034
We're looking for dedicated contributors to help maintain and grow this project. If you're interested in becoming a core contributor, please fill out our [Contributor Application Form](https://forms.gle/TBSteXSDCtBDwr5m7).
3135

36+
---
37+
3238
## Pull Request Guidelines
3339

3440
### 📝 PR Checklist
@@ -43,6 +49,8 @@ We're looking for dedicated contributors to help maintain and grow this project.
4349
3. Address all review comments
4450
4. Maintain clean commit history
4551

52+
---
53+
4654
## Coding Standards
4755

4856
### 💻 General Guidelines
@@ -51,6 +59,8 @@ We're looking for dedicated contributors to help maintain and grow this project.
5159
- Keep functions focused and small
5260
- Use meaningful variable names
5361

62+
---
63+
5464
## Development Setup
5565

5666
### 🔄 Initial Setup
@@ -100,6 +110,8 @@ pnpm run dev
100110

101111
**Note**: You will need Google Chrome Canary to run this locally if you use Chrome! It's an easy install and a good browser for web development anyway.
102112

113+
---
114+
103115
## Testing
104116

105117
Run the test suite with:
@@ -108,6 +120,8 @@ Run the test suite with:
108120
pnpm test
109121
```
110122

123+
---
124+
111125
## Deployment
112126

113127
To deploy the application to Cloudflare Pages:
@@ -118,6 +132,8 @@ pnpm run deploy
118132

119133
Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account.
120134

135+
---
136+
121137
# Docker Deployment Documentation
122138

123139
This guide outlines various methods for building and deploying the application using Docker.
@@ -172,6 +188,8 @@ docker run -p 5173:5173 --env-file .env.local bolt-ai:development
172188
docker run -p 5173:5173 --env-file .env.local bolt-ai:production
173189
```
174190

191+
---
192+
175193
## Deployment with Coolify
176194

177195
[Coolify](https://github.com/coollabsio/coolify) provides a straightforward deployment process:
@@ -189,6 +207,8 @@ docker run -p 5173:5173 --env-file .env.local bolt-ai:production
189207
- Adjust other environment variables as needed
190208
7. Deploy the application
191209

210+
---
211+
192212
## VS Code Integration
193213

194214
The `docker-compose.yaml` configuration is compatible with VS Code dev containers:
@@ -197,19 +217,25 @@ The `docker-compose.yaml` configuration is compatible with VS Code dev container
197217
2. Select the dev container configuration
198218
3. Choose the "development" profile from the context menu
199219

220+
---
221+
200222
## Environment Files
201223

202224
Ensure you have the appropriate `.env.local` file configured before running the containers. This file should contain:
203225
- API keys
204226
- Environment-specific configurations
205227
- Other required environment variables
206228

229+
---
230+
207231
## DEFAULT_NUM_CTX
208232

209233
The `DEFAULT_NUM_CTX` environment variable can be used to limit the maximum number of context values used by the qwen2.5-coder model. For example, to limit the context to 24576 values (which uses 32GB of VRAM), set `DEFAULT_NUM_CTX=24576` in your `.env.local` file.
210234

211235
First off, thank you for considering contributing to bolt.diy! This fork aims to expand the capabilities of the original project by integrating multiple LLM providers and enhancing functionality. Every contribution helps make bolt.diy a better tool for developers worldwide.
212236

237+
---
238+
213239
## Notes
214240

215241
- Port 5173 is exposed and mapped for both development and production environments

docs/docs/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ https://thinktank.ottomator.ai
99

1010
bolt.diy is an AI-powered web development agent that allows you to prompt, run, edit, and deploy full-stack applications directly from your browser—no local setup required. If you're here to build your own AI-powered web dev agent using the Bolt open source codebase, [click here to get started!](./CONTRIBUTING.md)
1111

12+
---
13+
1214
## What Makes bolt.diy Different
1315

1416
Claude, v0, etc are incredible- but you can't install packages, run backends, or edit code. That’s where bolt.diy stands out:
@@ -26,6 +28,8 @@ Whether you’re an experienced developer, a PM, or a designer, bolt.diy allows
2628

2729
For developers interested in building their own AI-powered development tools with WebContainers, check out the open-source Bolt codebase in this repo!
2830

31+
---
32+
2933
## Setup
3034

3135
Many of you are new users to installing software from Github. If you have any installation troubles reach out and submit an "issue" using the links above, or feel free to enhance this documentation by forking, editing the instructions, and doing a pull request.
@@ -128,6 +132,8 @@ When you run the Docker Compose command with the development profile, any change
128132
make on your machine to the code will automatically be reflected in the site running
129133
on the container (i.e. hot reloading still applies!).
130134

135+
---
136+
131137
## Run Without Docker
132138

133139
1. Install dependencies using Terminal (or CMD in Windows with admin permissions):
@@ -148,6 +154,8 @@ sudo npm install -g pnpm
148154
pnpm run dev
149155
```
150156

157+
---
158+
151159
## Adding New LLMs:
152160

153161
To make new LLMs available to use in this version of bolt.diy, head on over to `app/utils/constants.ts` and find the constant MODEL_LIST. Each element in this array is an object that has the model ID for the name (get this from the provider's API documentation), a label for the frontend model dropdown, and the provider.
@@ -156,6 +164,8 @@ By default, Anthropic, OpenAI, Groq, and Ollama are implemented as providers, bu
156164

157165
When you add a new model to the MODEL_LIST array, it will immediately be available to use when you run the app locally or reload it. For Ollama models, make sure you have the model installed already before trying to use it here!
158166

167+
---
168+
159169
## Available Scripts
160170

161171
- `pnpm run dev`: Starts the development server.
@@ -167,6 +177,8 @@ When you add a new model to the MODEL_LIST array, it will immediately be availab
167177
- `pnpm run typegen`: Generates TypeScript types using Wrangler.
168178
- `pnpm run deploy`: Builds the project and deploys it to Cloudflare Pages.
169179

180+
---
181+
170182
## Development
171183

172184
To start the development server:
@@ -177,6 +189,8 @@ pnpm run dev
177189

178190
This will start the Remix Vite development server. You will need Google Chrome Canary to run this locally if you use Chrome! It's an easy install and a good browser for web development anyway.
179191

192+
---
193+
180194
## Tips and Tricks
181195

182196
Here are some tips to get the most out of bolt.diy:

0 commit comments

Comments
 (0)