Skip to content

README.md

Latest commit

 

History

History
20 lines (16 loc) · 1.02 KB

README.md

File metadata and controls

20 lines (16 loc) · 1.02 KB
Raw

Documentation Workspace

This directory holds Archie documentation and repo-internal working material.

  • agents/: task briefs intended to be read and executed by coding agents.
  • epics/: high-level initiative definitions aligned with GitLab epics as a work item type.
  • work-items/: staged implementation plans and work item notes for larger changes. These are repo-local planning artifacts aligned with GitLab work items, not GitLab milestones.
  • architecture/: architecture and distro design notes. Architecture decisions are recorded under architecture/decisions/.
  • assets/: images used by the documentation.
  • user/: end-user installation, migration, and usage guides.
  • development/: contributor development-environment guides.

Relevant operational guides include:

  • user/GUIDE.md: main Archie installation and deployment handbook.
  • user/DEVELOPMENT.md: host-side development tooling and virtualization setup.
  • development/DEV_ENV.md: Incus VM bootstrap flow for disposable Archie development guests.