Skip to content

Commit de59588

Browse files
authored
Documentation consistency improvements (#349)
* Rename files to kebab-case for consistency - FAQ: Backup and Restore.md → backup-and-restore.md - FAQ: Cloud Storage.md → cloud-storage.md - Saltbox: accessing_apps.md → accessing-apps.md - Saltbox: install_types.md → install-types.md - Apps: hetzner_nfs.md → hetzner-nfs.md - Update mkdocs.yml navigation references * Add YAML frontmatter to all sandbox apps - Add standardized frontmatter with hide/tags metadata - Include semantic tags for app categorization - 162+ apps now have consistent frontmatter structure - Improves SEO and navigation organization * Fix image alt text in Plex documentation - Add descriptive alt text for folder selection images - Improves accessibility compliance - Replaces empty space alt text with meaningful descriptions * Fix internal links after file renames - Update all references to renamed files - Fix broken links to accessing-apps.md, install-types.md, hetzner-nfs.md - Ensures documentation builds without warnings * Fix ruTorrent.md filename case sensitivity issue - Properly rename ruTorrent.md to rutorrent.md - Resolves navigation mismatch in mkdocs.yml - Fixes case-sensitive filesystem compatibility * ruTorrent fix * Fix file naming and admonition formatting consistency * Fix list formatting and code block language consistency * Add missing H1 headings and fix excessive blank lines * Improve link accessibility by replacing 'here' links with descriptive text * Add alt text to images in reference and app documentation for accessibility * Add alt text to themepark documentation images for accessibility * Fix broken internal links to system.md after file rename * Add docker compose and docker run related tags to your-own-containers page * Fix capitalization consistency and improve grammar across documentation - Standardize Saltbox, Cloudflare, Google Drive capitalization - Fix grammar issues in your-own-containers page - Improve writing clarity and punctuation - Correct possessive forms and compound sentences * Fix broken anchor link in your-own-containers page - Update link fragment to match actual heading ID - Fixes warning about missing anchor #docker-compose
1 parent f472271 commit de59588

File tree

234 files changed

+1778
-276
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

234 files changed

+1778
-276
lines changed

docs/advanced/crowdsec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ So any changes to these will be lost next time the role runs.
123123

124124
Example:
125125

126-
```bash
126+
```shell
127127
sb install crowdsec
128128
```
129129

docs/advanced/feeder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ _Note: Running the below commands will replace your `unionfs.service` or `merger
2020

2121
The following steps will be done on the Mediabox.
2222

23-
1. In `rclone config`, create an `sftp` remote to your Feederbox called `feeder` (Here is an [asciicast](https://asciinema.org/a/184084?t=0&speed=1&size=medium&cols=75&rows=25) video walking through the process). The general process of creating an rclone remote is discussed [here](../reference/guides/rclone-remote.md).
23+
1. In `rclone config`, create an `sftp` remote to your Feederbox called `feeder` (Here is an [asciicast](https://asciinema.org/a/184084?t=0&speed=1&size=medium&cols=75&rows=25) video walking through the process). The general process of creating an rclone remote is discussed in the [rclone remote guide](../reference/guides/rclone-remote.md).
2424

2525
_Note: If you don't already have one, add the `feederbox` [subdomain](../reference/subdomain.md) and point it to your Feederbox's IP address. If you are using Cloudflare, make sure CDN/Proxy is not enabled for this subdomain._
2626

docs/advanced/styled-error-pages.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ There are initially seven "themes" available, which are stored in `/opt/error_pa
3232
cats ghost hacker-terminal l7-dark l7-light noise shuffle
3333
```
3434

35-
Samples of the themed pages can be viewed [here](https://tarampampam.github.io/error-pages/)
35+
Samples of the themed pages can be viewed in the [error pages gallery](https://tarampampam.github.io/error-pages/)
3636

3737
## How do I change the theme?
3838

@@ -62,13 +62,13 @@ These error pages do not work with every app; do your own a/b testing to verify
6262

6363
You can find the Saltbox roles that are known to NOT work with:
6464

65-
```bash
65+
```shell
6666
grep -Ril "_traefik_error_pages_enabled: false" /srv/git/saltbox/roles | cut -d/ -f6 | sort -u
6767
```
6868

6969
You can find the Sandbox roles that are known to NOT work with:
7070

71-
```bash
71+
```shell
7272
grep -Ril "_traefik_error_pages_enabled: false" /opt/sandbox/roles | cut -d/ -f5 | sort -u
7373
```
7474

docs/advanced/themepark.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ For example:
1515

1616
NZBGet default appearance:
1717

18-
![](images/nzbget-before.png)
18+
![NZBGet interface showing default appearance before theme application](images/nzbget-before.png)
1919

2020
NZBGet with the "nord" theme:
2121

22-
![](images/nzbget-nord.png)
22+
![NZBGet interface with nord theme applied showing dark color scheme](images/nzbget-nord.png)
2323

2424
Sonarr with the "hotline" theme:
2525

26-
![](images/sonarr-hotline.png)
26+
![Sonarr interface with hotline theme showing bright pink and dark styling](images/sonarr-hotline.png)
2727

2828
Choose the theme and apply it to containers in in inventory:
2929

@@ -71,7 +71,7 @@ plex_themepark_enabled: true
7171
nzbhydra2_themepark_enabled: true
7272
```
7373
74-
Available themes can be found [here](https://docs.theme-park.dev/theme-options/). Refer to them in the inventory file by name:
74+
Available themes can be found in the [Theme Park documentation](https://docs.theme-park.dev/theme-options/). Refer to them in the inventory file by name:
7575
7676
```text
7777
organizr

docs/advanced/user-crontab-examples.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ If you are unfamiliar with the syntax shown below, [crontab generator](https://c
1919

2020
To edit your crontab, enter `crontab -e`
2121

22-
```bash
22+
```shell
2323
PATH=/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin
2424
@daily cd /opt/plex-meta-manager && python plex-meta-manager.py -r
2525
0 7 * * 7 sudo PATH='/usr/bin:/bin:/usr/local/bin' env ANSIBLE_CONFIG='/srv/git/saltbox/ansible.cfg' 'sb install backup' -v >> '/home/seed/logs/saltbox_backup.log' 2>&1
@@ -50,12 +50,12 @@ PATH=/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin
5050

5151
This script deletes
5252

53-
* everything under a size of 100M
54-
* every unwanted file immediately
55-
* everything but the wanted files after 10 hours
56-
* every empty folder
53+
- everything under a size of 100M
54+
- every unwanted file immediately
55+
- everything but the wanted files after 10 hours
56+
- every empty folder
5757

58-
```bash
58+
```shell
5959
#!/bin/bash
6060
#####################################################
6161
# script by pho
@@ -135,7 +135,7 @@ eval "${command}"
135135

136136
Note that this script is specific to its author's setup when it was written. It probably won't work for you as-is. You'll need to edit the paths to match your situation.
137137

138-
```Bash
138+
```shell
139139
#!/bin/bash
140140
find /mnt/local/downloads/nzbget/completed/sonarr/* -type d -mmin +60 -ls -exec rm -rf {} + 2>/dev/null
141141
find /mnt/local/downloads/nzbget/completed/radarr/* -type d -mmin +60 -ls -exec rm -rf {} + 2>/dev/null
@@ -149,7 +149,7 @@ find /mnt/local/downloads/nzbget/completed/anime/* -type d -mmin +60 -ls -exec r
149149

150150
### RXWatcher's optimize.sh
151151

152-
```bash
152+
```shell
153153
#!/bin/sh
154154
# Get the contents of the Preferences file, keep only what we need, push to a temp, then use it in the curl command
155155

0 commit comments

Comments
 (0)