Skip to content

docs(repo): scaffold documentation-first direction, add ADRs, templates, and archive legacy infra - #10

Open
azunaVT wants to merge 1 commit into
mainfrom
codex/restructure-repository-for-documentation-first-direction-0050cy
Open

docs(repo): scaffold documentation-first direction, add ADRs, templates, and archive legacy infra#10
azunaVT wants to merge 1 commit into
mainfrom
codex/restructure-repository-for-documentation-first-direction-0050cy

Conversation

@azunaVT

@azunaVT azunaVT commented Mar 12, 2026

Copy link
Copy Markdown
Collaborator

Motivation

  • Pivot the repository to a documentation-first, Proxmox-first homelab platform direction to replace the previous bare-metal Talos/PXE focus.
  • Capture canonical architecture, decisions, inventories, runbooks, and a prioritized roadmap so execution is repeatable and reviewable.
  • Standardize GitHub workflows by providing issue and PR templates and area README anchors for future work.

Description

  • Add a top-level README.md that documents the Proxmox-first direction, repo structure, and reading path for initial work.
  • Add a full docs scaffold under docs/ including architecture/, decisions/ (ADRs ADR-001..ADR-005), inventory/, roadmap/, runbooks/, and vision/ to capture design goals, TODOs, and milestones.
  • Introduce GitHub templates in .github/ with issue templates (decision.yml, epic.yml, task.yml) and a pull_request_template.md to standardize planning and PRs.
  • Create area README stubs for proxmox/, kubernetes/, argocd/, ai/, automation/, scripts/, and argocd/ to organize future implementation artifacts.
  • Archive the legacy bare-metal/Talos Terraform and infra material into docs/archive/legacy-baremetal-talos-pxe/, remove the sensitive infra/live/prod/terraform.auto.tfvars, and replace it with a redacted example in the archive.

Testing

  • No automated tests were run because this is a documentation and repository re-organization change.

Codex Task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant