ilia/homelab-notes
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor README and SearXNG notes for improved formatting and clarity
All checks were successful
CI / skip-ci-check (pull_request) Successful in 1m27s
Details
CI / markdown-lint (pull_request) Successful in 1m29s
Details
CI / yaml-validate (pull_request) Successful in 1m30s
Details

Browse Source 
- Updated README.md to enhance the prompt structure for generating service documentation.
- Reformatted code blocks in searxng-lxc-notes.md for better readability and consistency.
This commit is contained in:
ilia 2026-01-07 12:23:21 -05:00
parent bdb4330dca
commit d8e98b1aa2
2 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -34,8 +34,8 @@ When adding a new container/VM/service, use this prompt with an LLM to generate
> - Capture design/architecture decisions (networking, reverse proxy, storage, security). > - Capture design/architecture decisions (networking, reverse proxy, storage, security).
> - Document IPs, hostnames, ports, container names, and paths that are specific to my environment. > - Document IPs, hostnames, ports, container names, and paths that are specific to my environment.
> - Include trimmed config examples (docker-compose, Caddy/nginx, app config) with comments where helpful. > - Include trimmed config examples (docker-compose, Caddy/nginx, app config) with comments where helpful.
> - Add a small “Deployment steps” section summarizing the exact commands I used (cd, docker compose up, systemctl, etc.). > - Add a small "Deployment steps" section summarizing the exact commands I used (cd, docker compose up, systemctl, etc.).
> - Add brief “Troubleshooting notes” if we fixed any issues (e.g., wrong port binding, DNS, reverse proxy issues). > - Add brief "Troubleshooting notes" if we fixed any issues (e.g., wrong port binding, DNS, reverse proxy issues).
> >
> Do NOT invent services or values that I did not show you. > Do NOT invent services or values that I did not show you.
> Only use the information I provide plus obvious inferences (e.g., 0.0.0.0:8080 means accessible on LAN). > Only use the information I provide plus obvious inferences (e.g., 0.0.0.0:8080 means accessible on LAN).