docs
This commit is contained in:
parent
e276c47686
commit
f9e276282a
12 changed files with 26 additions and 50 deletions
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue