diff --git a/docs/README.md b/docs/README.md index ce7e48e..9aca520 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,8 +2,8 @@ > Auto-generated documentation for the homelab deployment > -> Generated on: $(date -R) -> Source: $(pwd) +> Generated on: Wed, 30 Jul 2025 02:13:08 +0200 +> Source: /home/plasmagoat/homelab ## 📚 Documentation Files @@ -44,7 +44,7 @@ homelab-generate-docs /path/to/output - **Total Nodes**: 2 - **Homelab-Enabled Nodes**: 2 -- **Generated**: ons 30 jul 01:56:04 CEST 2025 +- **Generated**: Wed, 30 Jul 2025 02:13:11 +0200 ## 🛠️ Management Tools @@ -64,11 +64,35 @@ homelab-generate-docs /path/to/output ### GitHub Actions Example +```yaml +name: Generate Documentation +on: + push: + branches: [ main ] +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: cachix/install-nix-action@v24 + - name: Generate docs + run: nix develop --command homelab-generate-docs ./docs + - name: Commit docs + run: | + git add docs/ + git commit -m "docs: update homelab documentation" || exit 0 + git push +``` ### Manual Generation - +```bash +# From your homelab directory +nix develop +homelab-generate-docs ./docs +git add docs/ && git commit -m "Update docs" +``` --- diff --git a/docs/current-deployment.md b/docs/current-deployment.md index 9fe7850..fbfabf3 100644 --- a/docs/current-deployment.md +++ b/docs/current-deployment.md @@ -2,7 +2,7 @@ > Current homelab deployment configuration > -> Generated on: Wed, 30 Jul 2025 01:55:52 +0200 +> Generated on: Wed, 30 Jul 2025 02:13:01 +0200 > Working directory: /home/plasmagoat/homelab ## Deployment Summary diff --git a/docs/fleet-overview.md b/docs/fleet-overview.md index b8b7c7e..92f2991 100644 --- a/docs/fleet-overview.md +++ b/docs/fleet-overview.md @@ -2,7 +2,7 @@ > Auto-generated fleet overview > -> Generated on: Wed, 30 Jul 2025 01:55:28 +0200 +> Generated on: Wed, 30 Jul 2025 02:12:41 +0200 > Source: /home/plasmagoat/homelab ## Fleet Statistics diff --git a/docs/nodes.md b/docs/nodes.md index 9ef180a..de23565 100644 --- a/docs/nodes.md +++ b/docs/nodes.md @@ -2,7 +2,7 @@ > Detailed per-node configuration > -> Generated on: Wed, 30 Jul 2025 01:55:38 +0200 +> Generated on: Wed, 30 Jul 2025 02:12:50 +0200 ## Node: photos diff --git a/docs/services.md b/docs/services.md index 7d60e4a..f7cba44 100644 --- a/docs/services.md +++ b/docs/services.md @@ -2,7 +2,7 @@ > Complete service documentation with core options, feature integrations, and smart defaults > -> Generated on: Wed, 30 Jul 2025 01:55:42 +0200 +> Generated on: Wed, 30 Jul 2025 02:12:53 +0200 This document provides comprehensive documentation for homelab services, organized by: - **Core Service Options**: The main service configuration diff --git a/pkgs/homelab-docs/readme.nix b/pkgs/homelab-docs/readme.nix index 68ac51b..ea72b8f 100644 --- a/pkgs/homelab-docs/readme.nix +++ b/pkgs/homelab-docs/readme.nix @@ -7,7 +7,7 @@ writeShellScriptBin "homelab-docs-readme" '' #!/usr/bin/env bash set -euo pipefail - cat << 'EOF' + cat << EOF # Homelab Documentation > Auto-generated documentation for the homelab deployment @@ -30,7 +30,7 @@ writeShellScriptBin "homelab-docs-readme" '' ## 🚀 Quick Actions ### View Current Status - ```bash + \`\`\`bash # Service status across fleet (if homelab CLI is available) homelab services --global @@ -39,16 +39,16 @@ writeShellScriptBin "homelab-docs-readme" '' # Overall status homelab status - ``` + \`\`\` ### Update Documentation - ```bash + \`\`\`bash # Regenerate all documentation homelab-generate-docs ./docs # Generate in different directory homelab-generate-docs /path/to/output - ``` + \`\`\` ## 📋 Quick Stats @@ -68,7 +68,7 @@ writeShellScriptBin "homelab-docs-readme" '' echo "- **Total Nodes**: $total_nodes" echo "- **Homelab-Enabled Nodes**: $homelab_nodes" - echo "- **Generated**: $(date)" + echo "- **Generated**: $(date -R)" echo echo "## 🛠️ Management Tools" echo @@ -88,7 +88,7 @@ writeShellScriptBin "homelab-docs-readme" '' echo echo "### GitHub Actions Example" echo - echo "```yaml" + echo "\`\`\`yaml" echo "name: Generate Documentation" echo "on:" echo " push:" @@ -107,16 +107,16 @@ writeShellScriptBin "homelab-docs-readme" '' echo " git add docs/" echo " git commit -m \"docs: update homelab documentation\" || exit 0" echo " git push" - echo "```" + echo "\`\`\`" echo echo "### Manual Generation" echo - echo "```bash" + echo "\`\`\`bash" echo "# From your homelab directory" echo "nix develop" echo "homelab-generate-docs ./docs" echo "git add docs/ && git commit -m \"Update docs\"" - echo "```" + echo "\`\`\`" echo echo "---" echo