Documentation Restructure Proposal (v2)¶
Audit Snapshot (2026-02-26)¶
- Total markdown files:
197 - Current root split:
Operations:77Services:71Infrastructure:22Platforms:21Blog:5- Root
index.md:1 - Broken relative markdown links found:
38 - Proposed type split:
deployments:85workflows:37scripts:39reference:22blog:4index:10
Why Navigation Feels Hard¶
- The current structure mixes two different axes:
- By domain (
Platforms,Services,Infrastructure) - By purpose (
Operations,Reference,Deployment,Scripts) - Task-oriented docs are scattered:
- Example: deployment docs exist in
Platforms,Services, andOperations/Automation/.../Deployment. - Naming/link style drift is high:
- Many links use lowercase-kebab paths while files still use title case and spaces.
- This mismatch is a major contributor to broken links and poor discoverability.
Target IA (Content-Type First)¶
index.md
blog/
index.md
posts/
deployments/
index.md
platforms/
services/
automation/
workflows/
index.md
operations/
platforms/
scripts/
index.md
bash/
powershell/
batch/
services/
reference/
index.md
foundations/
infrastructure/
Folder Mapping Rules¶
Operations/Reference/**->scripts/**Services/**/Scripts/**->scripts/services/**Operations/**(except reference + deployment docs) ->workflows/operations/**- Platform operations/day-2 docs ->
workflows/platforms/** Platforms/**deployment/setup docs ->deployments/platforms/**Services/**deployment/setup docs ->deployments/services/**Operations/Automation/**/Deployment/**->deployments/automation/**Infrastructure/**+Operations/Foundations/**->reference/**- Normalize all destination paths to lowercase-kebab-case.
Generated Migration Artifact¶
- Full proposed path map:
reference/foundations/documentation-restructure-migration-map.csv - Columns:
current_pathproposed_pathdoc_typeconfidencereason
Manual Review Queue (Medium Confidence)¶
Platforms/Containerization/Kubernetes/Migrating Docker Compose YML to K8s.mdPlatforms/Virtualization/Hyper V/Failover Cluster/Rebuild Failover Cluster Replication.mdPlatforms/Virtualization/Hyper V/Forcefully Stop GuestVM.mdPlatforms/Virtualization/Hyper V/Kerberos Enabled VM Migration.mdPlatforms/Virtualization/Proxmox/Common Tasks.md
Phased Migration Sequence¶
- Phase 0: stabilize naming and links
- Lock naming convention: lowercase-kebab-case directories and files.
- Move only index pages first (
10files) to establish new top nav. - Phase 1: move scripts (
39files) - Lowest blast radius, immediate usability improvement.
- Phase 2: move workflows (
37files) - Consolidates day-2 operations and runbooks.
- Phase 3: move deployments (
85files) - Largest move set, do after scripts/workflows are stable.
- Phase 4: cleanup and verification
- Fix all internal links, remove old folders, and validate build output.
Guardrails For Future Docs¶
- Keep one primary intent per doc:
deployment,workflow,script, orreference. - Require an
index.mdin every first-level and second-level folder. - Use stable cross-links with root-relative paths after migration.
- Avoid adding new docs to legacy roots once migration starts.