Your Name
54592a5839
- Move all docs (DEV, AGENT_Context, algorithm) into DOC/ via git mv - Rewrite root README as short intro + quick start + links into DOC/ - Add per-area reference docs: SCRIPTS (core scripts + libs + features), POS (pos CLI + compose config), APPS (picker + catalog), SYSTEMD (units) - Add DOC/README.md index; fix all cross-references
1.5 KiB
1.5 KiB
Documentation
Everything in this folder is reference material for the Linux_post_install project. The root README is the short intro + quick start; this folder holds the detail.
| Document | What it covers |
|---|---|
| SCRIPTS.md | Core installer scripts: install.sh, preinstall.sh, postinstall.sh, lib/common.sh, lib/flags.sh, features/autostart.sh — purpose, how each works, configuration |
| POS.md | The pos CLI: dispatcher, every pos-* command, Docker Compose / ScaleTail config, legacy wrappers, flag CLIs |
| APPS.md | Optional apps: apps/install.sh picker, installer conventions, full app catalog |
| SYSTEMD.md | Systemd units (autostart.service, ssh-agent.service), feature-flag gating, bash completion |
| DEV.md | Developer guide: architecture, conventions, how to add tools/apps/features, commit guidelines |
| AGENT_Context_Project.md | Single-source context doc for AI agents working on the repo |
| algorithm.md | ASCII diagrams: install flow, pos dispatch, compose up, config cascade, logging, vbox lifecycle |
Quick navigation
- Just installed and want to use it? → POS.md
- Adding a package? → SCRIPTS.md → preinstall.sh
- Adding a CLI tool or app? → DEV.md
- First deploy of a self-hosted service? → POS.md → Docker Compose