Skip to content

Give an agent a documentation task

contributionobservedEvidence reviewed 2026-10-06

Replace the machine names and scope in this prompt before giving it to the agent that operates them.

Please document [machines or services] in my private always-akshat/dev-environment repository.
Read AGENTS.md, CONTRIBUTING.md and src/content/docs/contributing/add-machine.md. Use your existing knowledge and authorized read-only access. Follow the existing vocabulary, inventory, architecture model and templates.
Document roles, access, services, stored data, normal tasks and common recovery steps. Add dated evidence and mark unknown or untested behavior. Do not change machine configuration or copy secrets, raw logs, recordings or application source merely to document the setup.
Update affected inventory, diagrams and prose together. Follow the contribution checklist, preview the result, and submit a focused PR. Include remaining questions and any unclear guidance you encountered. Keep script migration separate unless it is included in my requested scope.

The build-server/NVR contribution in PR #1 is a worked example, including feedback that improved the guide.