Skip to content

Commit 6984dee

Browse files
committed
Update links in documentation to use consistent lowercase formatting for 'Getting Started' guide
1 parent 3c681d7 commit 6984dee

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Gearbox is a general-purpose monitoring and management platform with a plugin-ba
1919

2020
## 🚀 Getting Started
2121

22-
**New to Gearbox?** Follow our comprehensive [Getting Started Guide](docs/GETTING_STARTED.md) for step-by-step instructions on:
22+
**New to Gearbox?** Follow our comprehensive [Getting Started Guide](docs/getting-started.md) for step-by-step instructions on:
2323

2424
- Installing the Gearbox dashboard and agent
2525
- Generating and configuring API keys

TASKS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -410,15 +410,15 @@ Update all widget config schemas:
410410

411411
- [x] Update `.env.example` - references to /settings/servers
412412
- [x] Update `docs/development.md` - configuration instructions
413-
- [x] Update `docs/GETTING_STARTED.md` - all "server" → "box"
413+
- [x] Update `docs/getting-started.md` - all "server" → "box"
414414
- [x] Update `README.md` - terminology consistency
415415
- [x] Update plugin README files - "multi-server support" → "multi-box support"
416416
- [x] Update comments in main.go
417417

418418
**Files:**
419419
- `gearbox/.env.example`
420420
- `gearbox/docs/development.md`
421-
- `docs/GETTING_STARTED.md`
421+
- `docs/getting-started.md`
422422
- `README.md`
423423
- `gearbox/cmd/server/main.go`
424424

File renamed without changes.

gearbox/internal/framework/templates/pages/haproxy_settings.templ

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,7 @@ templ haProxyBoxForm(user *models.User, server *database.BoxDB, isEdit bool, err
475475
Gearbox requires at least one server or workstation to monitor to function - we call these a "Box".
476476
To monitor a Box, you must first install gearbox-agent on it and configure an API key.
477477
Use the "Generate API Key" button below to create a key, then add it to the <code class="px-1 py-0.5 bg-gray-100 dark:bg-slate-700 rounded text-xs">GEARBOX_API_KEY</code> environment variable on your Box.
478-
See the <a href="https://github.com/sarg3nt/gearbox/blob/main/docs/GETTING_STARTED.md" target="_blank" class="text-blue-600 dark:text-blue-400 hover:underline">Getting Started Guide</a> { "for" } step-by-step instructions.
478+
See the <a href="https://github.com/sarg3nt/gearbox/blob/main/docs/getting-started.md" target="_blank" class="text-blue-600 dark:text-blue-400 hover:underline">Getting Started Guide</a> { "for" } step-by-step instructions.
479479
</p>
480480
</div>
481481
if errorMsg != "" {

0 commit comments

Comments
 (0)