chore(docs): update mdbook-lint to 0.13.2 with CI mode (#493)

* chore: remove outdated implementation tracking file

* chore(docs): update mdbook-lint to 0.13.2 with CI mode

- Update mdbook-lint from 0.13.1 to 0.13.2 (fixes mdbook 0.5 compatibility)
- Use CI mode (mdbook-lint lint) instead of preprocessor mode
- Update .mdbook-lint.toml config to disable noisy rules
- Remove preprocessor config from book.toml

* fix(docs): resolve all mdbook-lint errors

Fix 123 lint errors across 48 documentation files:

- MD052 (20): Fix checklist items interpreted as reference links
- MDBOOK010 (2): Escape shell $ variables in inline code
- MDBOOK004 (15): Make duplicate chapter titles unique
- MDBOOK006 (4): Remove invalid cross-reference anchors
- MDBOOK002 (82): Remove broken internal links to non-existent files

Author: joshrotenberg

.github/workflows/mdbook.yml

@@ -5,12 +5,12 @@ on:
     branches:
       - main
     paths:
-      - 'docs/**'
-      - '.github/workflows/mdbook.yml'
+      - "docs/**"
+      - ".github/workflows/mdbook.yml"
   pull_request:
     paths:
-      - 'docs/**'
-      - '.github/workflows/mdbook.yml'
+      - "docs/**"
+      - ".github/workflows/mdbook.yml"
   workflow_dispatch:
 
 permissions:
@@ -33,8 +33,15 @@ jobs:
       - name: Setup mdBook
         uses: peaceiris/actions-mdbook@v2
         with:
-          mdbook-version: 'latest'
+          mdbook-version: "latest"
 
+      - name: Install mdbook-lint
+        run: cargo install mdbook-lint --version 0.13.2 --locked
+
+      - name: Lint documentation
+        run: |
+          cd docs
+          mdbook-lint lint . --config .mdbook-lint.toml
 
       - name: Build book
         run: |
@@ -57,4 +64,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4
+        uses: actions/deploy-pages@v4

.mdbook-lint.toml

@@ -1,21 +1,18 @@
 # mdbook-lint configuration for redisctl documentation
 # https://github.com/joshrotenberg/mdbook-lint
 
-# Temporarily disable rules with known issues
-disabled-rules = [
-    "MDBOOK010",  # Math block detection - false positives with $ in shell code blocks (issue #141)
-    "MDBOOK005",  # Orphaned files - incorrectly checking outside src directory (issue #142)
-    "MDBOOK002",  # Internal link validation - false positives with existing files
-]
-
-# Don't fail the build on warnings or errors during initial setup
+# Fail on errors but not warnings
 fail-on-warnings = false
-fail-on-errors = false
+fail-on-errors = true
 
-# Configure specific rules
-[rules.MD013]
-# Allow longer lines for code examples and CLI output
-line_length = 120
+# Disable rules that are too noisy for this project
+disabled-rules = [
+    "MD013",      # Line length - too strict for documentation
+    "MDBOOK005",  # Orphaned files - we have WIP docs
+    "MDBOOK023",  # Chapter title match - intentionally different
+    "CONTENT004", # Heading capitalization - we use sentence case
+    "CONTENT007", # Terminology consistency - too strict
+]
 
 [rules.MD024]
 # Allow duplicate headings in different sections
@@ -24,10 +21,3 @@ enabled = true
 [rules.MD041]
 # Require first line to be a heading
 enabled = true
-
-# Future configuration options when issues are resolved:
-# [rules.MDBOOK005]
-# search-path = "src"  # Only check within src directory
-# 
-# [rules.MDBOOK010]  
-# skip-code-blocks = true  # Skip math detection in code blocks

docs/.mdbook-lint.toml

@@ -1,42 +1,18 @@
 # mdbook-lint configuration for redisctl documentation
 # https://github.com/joshrotenberg/mdbook-lint
 
-# Temporarily disable rules with known issues
-disabled-rules = [
-    "MDBOOK010",  # Math block detection - false positives with $ in shell code blocks (issue #141)
-    "MDBOOK005",  # Orphaned files - incorrectly checking outside src directory (issue #142)
-    "MDBOOK002",  # Internal link validation - false positives with existing files
-]
-
-# Don't fail the build on warnings, but show them for fixing
+# Fail on errors but not warnings
 fail-on-warnings = false
-fail-on-errors = false
-
-# Enable rules that should be fixable
-[rules.MD022]
-# Require blank lines around headings 
-enabled = true
-
-[rules.MD032]
-# Require blank lines around lists
-enabled = true
-
-[rules.MD031]
-# Require blank lines around fenced code blocks
-enabled = true
-
-[rules.MD006]
-# Lists should start at beginning of line
-enabled = true
-
-[rules.MD047]
-# Files should end with single newline
-enabled = true
+fail-on-errors = true
 
-# Configure specific rules
-[rules.MD013]
-# Allow longer lines for code examples and CLI output
-line_length = 120
+# Disable rules that are too noisy for this project
+disabled-rules = [
+    "MD013",      # Line length - too strict for documentation
+    "MDBOOK005",  # Orphaned files - we have WIP docs
+    "MDBOOK023",  # Chapter title match - intentionally different
+    "CONTENT004", # Heading capitalization - we use sentence case
+    "CONTENT007", # Terminology consistency - too strict
+]
 
 [rules.MD024]
 # Allow duplicate headings in different sections
@@ -45,10 +21,3 @@ enabled = true
 [rules.MD041]
 # Require first line to be a heading
 enabled = true
-
-# Future configuration options when issues are resolved:
-# [rules.MDBOOK005]
-# search-path = "src"  # Only check within src directory
-# 
-# [rules.MDBOOK010]  
-# skip-code-blocks = true  # Skip math detection in code blocks

docs/book.toml

@@ -13,8 +13,3 @@ edit-url-template = "https://github.com/joshrotenberg/redisctl/edit/main/docs/{p
 [output.html.fold]
 enable = true
 level = 0
-
-# Temporarily disabled for reorganization
-# [preprocessor.lint]
-# command = "mdbook-lint"
-# renderer = ["html"]

docs/src/api-reference/api.md

@@ -154,14 +154,14 @@ redisctl api cloud post /subscriptions/123456/databases/789/acl/users --data @us
 
 ## Redis Enterprise API
 
-### Base URL
+### Enterprise Base URL
 `https://<cluster-address>:9443`
 
-### Authentication
+### Enterprise Authentication
 - Basic Auth: `username:password`
 - Header: `Authorization: Basic <base64>`
 
-### Common Endpoints
+### Enterprise Endpoints
 
 #### Cluster
 ```bash

docs/src/cloud/commands.md

@@ -20,7 +20,7 @@ Direct access to any REST endpoint when you need full control.
 redisctl api cloud <method> <path> [options]
 ```
 
-See [Raw API Access](./api-access.md) for details.
+See Raw API Access for details.
 
 ## 3. Workflows (Coming Soon)
 

docs/src/cloud/commands/subscriptions.md

@@ -208,9 +208,9 @@ redisctl cloud fixed-subscription create --data @fixed-subscription.json --wait
 
 ## Related Commands
 
-- [Databases](./databases.md) - Manage databases within subscriptions
-- [Network Connectivity](./connectivity.md) - Configure VPC peering and private endpoints
-- [Provider Accounts](./provider-accounts.md) - Manage cloud provider integrations
+- Databases - Manage databases within subscriptions
+- Network Connectivity - Configure VPC peering and private endpoints
+- Provider Accounts - Manage cloud provider integrations
 
 ## Common Patterns
 

docs/src/cloud/core-resources/databases.md

@@ -343,8 +343,8 @@ done
 ## Related Commands
 
 - [Subscriptions](./subscriptions.md) - Manage parent subscriptions
-- [ACL](./acl.md) - Configure access control
-- [Connectivity](./connectivity.md) - Set up VPC peering
+- ACL - Configure access control
+- Connectivity - Set up VPC peering
 
 ## API Reference
 

docs/src/cloud/core-resources/subscriptions.md

@@ -208,9 +208,9 @@ redisctl cloud fixed-subscription create --data @fixed-subscription.json --wait
 
 ## Related Commands
 
-- [Databases](./databases.md) - Manage databases within subscriptions
-- [Network Connectivity](./connectivity.md) - Configure VPC peering and private endpoints
-- [Provider Accounts](./provider-accounts.md) - Manage cloud provider integrations
+- Databases - Manage databases within subscriptions
+- Network Connectivity - Configure VPC peering and private endpoints
+- Provider Accounts - Manage cloud provider integrations
 
 ## Common Patterns
 

docs/src/common-features/profiles.md

@@ -45,7 +45,7 @@ redisctl profile set enterprise-prod \
 3. Click "Add API Key" and give it a name
 4. Copy both the Account key and Secret (you won't see the secret again!)
 
-### Redis Enterprise
+### Redis Enterprise Credentials
 
 - **URL**: `https://cluster-fqdn:9443`
 - **Username**: Configured during setup (often `[email protected]`)