Skip to content

Commit 6b59b47

Browse files
committed
docs(dev): normalize heading case
1 parent a90ada0 commit 6b59b47

File tree

1 file changed

+18
-60
lines changed

1 file changed

+18
-60
lines changed

DEVELOPMENT.md

Lines changed: 18 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ We are also collecting tokio's runtime tracing information that could be viewed
227227

228228
Common issues and solutions when developing GitButler.
229229

230-
### Turbo/Build Issues
230+
### Turbo/build issues
231231

232232
#### Case-sensitive volume problems
233233

@@ -241,59 +241,27 @@ If builds are hanging or behaving unexpectedly:
241241

242242
```bash
243243
# Stop the turbo daemon
244-
$ pnpm exec turbo daemon stop
244+
pnpm exec turbo daemon stop
245245

246246
# Clear turbo cache
247-
$ pnpm exec turbo daemon clean
247+
pnpm exec turbo daemon clean
248248

249249
# Restart development
250-
$ pnpm dev:desktop
250+
pnpm dev:desktop
251251
```
252252

253-
### Cache Issues
253+
### Cache issues
254254

255255
If you're seeing stale builds or unexpected behavior:
256256

257257
```bash
258-
# Clear all caches
259-
$ pnpm clean
260-
$ cargo clean
261-
$ rm -rf node_modules
262-
$ pnpm install
263-
```
264-
265-
### Platform-specific Issues
266-
267-
For Windows-specific build issues, refer to the [Building on Windows](#building-on-windows) section. Common issues include:
268-
269-
- Missing Perl interpreter for OpenSSL compilation
270-
- Incorrect npm prefix configuration
271-
- File permission issues with pnpm
272-
273-
#### macOS
274-
275-
- Ensure Xcode Command Line Tools are installed: `xcode-select --install`
276-
- If using Homebrew, ensure cmake is installed: `brew install cmake`
277-
278-
#### Linux
279-
280-
- Double-check all system dependencies are installed (see Prerequisites)
281-
- On some distributions, you may need additional development packages
282-
283-
### Node.js and pnpm Issues
284-
285-
#### pnpm installation failures
286-
287-
```bash
288-
# Disable and re-enable corepack
289-
$ corepack disable
290-
$ corepack enable
291-
292-
# Or install pnpm globally
293-
$ npm install -g pnpm
258+
rm -rf .turbo node_modules
259+
pnpm install
260+
# Optional (Rust artifacts):
261+
cargo clean
294262
```
295263

296-
#### Node version conflicts
264+
### Node.js & pnpm
297265

298266
Use the Node version pinned by `.nvmrc` (currently LTS “jod” / Node 22):
299267

@@ -303,31 +271,21 @@ nvm use
303271
node -v
304272
```
305273

306-
### Rust Issues
307-
308-
#### Cargo build failures
274+
Use pnpm via Corepack (avoid global installs):
309275

310276
```bash
311-
# Update Rust toolchain
312-
$ rustup update
313-
314-
# Clean and rebuild
315-
$ cargo clean
316-
$ cargo build
277+
corepack enable
278+
corepack pnpm -v
279+
# optionally pin a major:
280+
corepack prepare pnpm@10 --activate
317281
```
318282

319-
#### Missing system dependencies
320-
321-
On Linux, if you're getting linking errors, ensure all required system libraries are installed. Revisit the Prerequisites section for your distribution.
322-
323-
### Additional Resources
283+
### Additional resources
324284

325285
For issues specific to our toolchain components:
326286

327-
- [Turborepo Issues](https://github.com/vercel/turborepo/issues)
328-
- [Tauri Issues](https://github.com/tauri-apps/tauri/issues)
329-
- [Svelte Issues](https://github.com/sveltejs/svelte/issues)
330-
- [Rust Issues](https://github.com/rust-lang/rust/issues)
287+
- [Turborepo issues](https://github.com/vercel/turborepo/issues)
288+
- [Tauri issues](https://github.com/tauri-apps/tauri/issues)
331289

332290
If none of these solutions work, please check our [GitHub Issues](https://github.com/gitbutlerapp/gitbutler/issues) or create a new issue with detailed information about your system and the error you're encountering.
333291

0 commit comments

Comments
 (0)