Skip to content

Reorganize planning documentation: group related work and archive completed items#44

Merged
technicalpickles merged 1 commit intomainfrom
doc-reorg
Sep 10, 2025
Merged

Reorganize planning documentation: group related work and archive completed items#44
technicalpickles merged 1 commit intomainfrom
doc-reorg

Conversation

@technicalpickles
Copy link
Copy Markdown
Owner

🗂️ Planning Documentation Reorganization

This PR reorganizes the docs/planning/ directory to improve organization and make it easier to track project progress.

📁 Changes Made

Archived Completed Work (moved to docs/archive/planning/):

  • LLD Adoptionlld-adoption/ (plan.md, strategy.md)
  • Declarative Detector Consolidationdeclarative-consolidation/ (plan.md, testing-strategy.md)
  • Contextual Value Extractioncontextual-value-extraction.md
  • Override System Designoverride-system-design.md
  • Additional CLI Improvementsadditional-cli-improvements.md + implementation

Grouped Active Projects:

  • CLI Streamliningcli-streamlining/ (7 phase docs + status)
  • Aqua Distributionaqua-distribution/ (plan + signing validation + status)
  • Release Workflowrelease-workflow/ (plan + status)

📋 Standardized Structure

Each project directory now follows consistent naming:

  • `plan.md` - Original planning document
  • `status.md` - Current progress and next steps
  • `implementation-*.md` - Implementation details
  • `phase-*.md` - Phase-specific documentation

🛠️ Added Tools

  • Reorganization script: `docs/reorganize-planning-docs.sh` for future use
  • Updated README: `docs/planning/README.md` with current status and instructions

✅ Benefits

  • Clear separation between active and completed work
  • Better organization of multi-document projects
  • Easy progress tracking with status files
  • Consistent naming across all projects
  • Preserved history - all content moved, not deleted

This reorganization makes it much easier to understand current project status and find related documentation.

- Move completed work to docs/archive/planning/ with grouped structure
- Group active projects into dedicated directories (cli-streamlining, aqua-distribution, release-workflow)
- Apply standardized naming conventions (plan.md, status.md, phase-*.md)
- Add status tracking files for each active project
- Update planning README with current status and reorganization instructions
- Add reorganization script for future use
Copilot AI review requested due to automatic review settings September 10, 2025 14:13
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR reorganizes the docs/planning/ directory to improve project organization by separating active from completed work and grouping related documents.

  • Moves completed planning documents to docs/archive/planning/ for historical reference
  • Groups active multi-document projects into organized directories with standardized naming
  • Creates status tracking files for each active project to show current progress

Reviewed Changes

Copilot reviewed 7 out of 23 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/reorganize-planning-docs.sh Automation script for future reorganization tasks with safety checks
docs/planning/README.md Updated overview focusing on active projects with clear status indicators
docs/planning/cli-streamlining/status.md Status tracking for the CLI streamlining project (Phases 1-2 complete, Phase 3 in progress)
docs/planning/aqua-distribution/status.md Status tracking for the aqua distribution project (planned, waiting on dependencies)
docs/planning/aqua-distribution/plan.md Comprehensive plan for implementing aqua/mise distribution support
docs/planning/aqua-distribution/signing-validation.md Detailed validation strategy for release signing implementation
docs/planning/release-workflow/status.md Status tracking for the release workflow project (planned, lower priority)

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@technicalpickles technicalpickles merged commit a556156 into main Sep 10, 2025
4 checks passed
@technicalpickles technicalpickles deleted the doc-reorg branch September 10, 2025 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants