Problem
The repository contains substantial standards and architecture documentation, but an operator still has to assemble a complete workflow from multiple files. The first VM pilot exposed ambiguity about what to run, what was already decided, which step was blocked, and which component owns each action.
Documentation should let a new operator, intern, or automation agent complete common work without reconstructing the architecture from conversation history.
Goal
Create a clear documentation structure organized around outcomes and roles:
- CI worker host;
- test/staging environment host;
- production deployment host;
- application project onboarding;
- new physical location/VPS onboarding;
- credentials and GitHub-side prerequisites;
- installation, upgrade, repair, verification, rollback, and removal.
Required improvements
- Add a concise documentation landing page with a role and task index.
- Explain CI worker, tester, and deployer boundaries in plain language.
- Provide separate quickstarts for each host role.
- Make prerequisites, required credentials, stopping conditions, and expected results explicit.
- Link each manual runbook to its eventual one-command Bash installer.
- Provide copyable configuration examples containing fictional values only.
- Add end-to-end checklists and final-report templates.
- Identify which steps occur in GitHub, on Proxmox, on the Linux host, in private configuration, and in an application repository.
- Mark prototype-only, current, planned, and production-ready material clearly.
- Remove duplicated or contradictory instructions.
- Ensure every command states where it runs and whether it changes state.
- Include troubleshooting for the failures encountered during the first live pilot.
- Add a glossary for runner, worker, controller, scale set, tester, deployer, environment, artifact, and project contract.
- Keep public examples free of internal infrastructure details and credentials.
- Add link validation and documentation checks to CI.
Acceptance
A person unfamiliar with the project can select a goal from the documentation landing page and complete or safely stop the workflow without needing chat history.
The documentation must answer:
- What am I installing?
- Where does it run?
- Which configuration and credentials are required?
- What single command performs the operation?
- How do I verify success?
- How do I upgrade, repair, roll back, or remove it?
- What must never be combined or exposed?
Problem
The repository contains substantial standards and architecture documentation, but an operator still has to assemble a complete workflow from multiple files. The first VM pilot exposed ambiguity about what to run, what was already decided, which step was blocked, and which component owns each action.
Documentation should let a new operator, intern, or automation agent complete common work without reconstructing the architecture from conversation history.
Goal
Create a clear documentation structure organized around outcomes and roles:
Required improvements
Acceptance
A person unfamiliar with the project can select a goal from the documentation landing page and complete or safely stop the workflow without needing chat history.
The documentation must answer: