docs
Some checks failed
Test / tests (push) Failing after 1m30s
/ OpenTofu (push) Successful in 8s

This commit is contained in:
plasmagoat 2025-07-30 01:56:53 +02:00
parent e276c47686
commit f9e276282a
12 changed files with 26 additions and 50 deletions

View file

@ -7,12 +7,12 @@ writeShellScriptBin "homelab-docs-deployment" ''
#!/usr/bin/env bash
set -euo pipefail
cat << 'EOF'
cat << EOF
# Current Deployment State
> Current homelab deployment configuration
>
> Generated on: $(date)
> Generated on: $(date -R)
> Working directory: $(pwd)
## Deployment Summary

View file

@ -6,12 +6,12 @@ writeShellScriptBin "homelab-docs-fleet" ''
#!/usr/bin/env bash
set -euo pipefail
cat << 'EOF'
cat << EOF
# Homelab Fleet Overview
> Auto-generated fleet overview
>
> Generated on: $(date)
> Generated on: $(date -R)
> Source: $(pwd)
## Fleet Statistics

View file

@ -6,12 +6,12 @@ writeShellScriptBin "homelab-docs-nodes" ''
#!/usr/bin/env bash
set -euo pipefail
cat << 'EOF'
cat << EOF
# Node Configurations
> Detailed per-node configuration
>
> Generated on: $(date)
> Generated on: $(date -R)
EOF

View file

@ -12,7 +12,7 @@ writeShellScriptBin "homelab-docs-readme" ''
> Auto-generated documentation for the homelab deployment
>
> Generated on: $(date)
> Generated on: $(date -R)
> Source: $(pwd)
## 📚 Documentation Files
@ -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

View file

@ -6,12 +6,12 @@ writeShellScriptBin "homelab-docs-services" ''
#!/usr/bin/env bash
set -euo pipefail
cat << 'EOF'
cat << EOF
# Service Catalog
> Complete service documentation with core options, feature integrations, and smart defaults
>
> Generated on: $(date)
> Generated on: $(date -R)
This document provides comprehensive documentation for homelab services, organized by:
- **Core Service Options**: The main service configuration