yay
Some checks failed
Test / tests (push) Failing after 1m31s
/ OpenTofu (push) Successful in 9s

This commit is contained in:
plasmagoat 2025-07-30 02:13:32 +02:00
parent f9e276282a
commit 6ba25b90a9
6 changed files with 42 additions and 18 deletions

View file

@ -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