Reorganize ATVM workspace into scripts, docs, inventory, and archive
Restructure the ATVM folder to separate executable scripts from workflow documentation and long-form environment reference material. Move setup and automation scripts into scripts/, move setup and automation guides into docs/, add top-level README and workflow conventions, and organize durable environment details into inventory/ while preserving the original long-form ATVM notes under archive/imported-notes/. Update internal documentation paths to match the new layout and remove the archived Zone.Identifier metadata file.
This commit is contained in:
30
atvm/docs/workflow/conventions.md
Normal file
30
atvm/docs/workflow/conventions.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# ATVM Workspace Conventions
|
||||
|
||||
## File Roles
|
||||
- `guide.md`
|
||||
- authoritative workflow rules, defaults, and checklists
|
||||
- `examples.md`
|
||||
- reusable command examples only
|
||||
- `run-learnings.md`
|
||||
- dated lessons captured only when a run produced a new lasting insight
|
||||
- `inventory/*.md`
|
||||
- durable environment reference and listings
|
||||
- `archive/imported-notes/*.md`
|
||||
- preserved source material kept for completeness and traceability
|
||||
|
||||
## Update Policy
|
||||
- Update `docs/setup/guide.md` when setup/bootstrap workflow behavior changes.
|
||||
- Update `docs/automation/guide.md` when automation workflow behavior changes.
|
||||
- Update `docs/automation/examples.md` when a reusable example pattern changes.
|
||||
- Update `run-learnings.md` files only when a run created a new lesson worth preserving.
|
||||
- Keep inventory details in `inventory/` rather than mixing them into workflow guides.
|
||||
|
||||
## Path Conventions
|
||||
- Prefer actual repo paths under `/home/aw/code/cds/atvm/...` in documentation.
|
||||
- Keep top-level navigation in `README.md` and `AGENTS.md`.
|
||||
- Keep executable assets under `scripts/`.
|
||||
|
||||
## Archive Policy
|
||||
- Preserve imported long-form notes under `archive/imported-notes/`.
|
||||
- Do not rely on archived notes as the primary operational runbook when a current guide exists.
|
||||
- Keep detailed listings available; reorganization should improve navigation, not remove information.
|
||||
Reference in New Issue
Block a user