Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 30, 2025

Repository restructuring was completed but documentation still referenced deprecated paths (src/rules-compiler-shell/, src/shell-scripts/, src/powershell-modules/) instead of current locations (src/shell/, src/powershell/). Multiple completed migration summaries remained in active docs despite work being finished.

Path Corrections

  • Updated all references: src/rules-compiler-shell/src/shell/
  • Updated all references: src/shell-scripts/src/shell/
  • Updated all references: src/powershell-modules/src/powershell/
  • Removed references to non-existent Windows Batch and PowerShell wrapper scripts

Files updated: README.md, docs/{AGENTS,README,ENVIRONMENT_VARIABLES,compiler-comparison,docker-guide,getting-started,centralized-package-quick-reference}.md

Archived Completed Work

Moved to docs/archive/ with explanatory README:

  • PHASE2_IMPLEMENTATION.md (shell reorganization - complete)
  • RESTRUCTURING_SUMMARY.md (repository restructuring - complete)
  • centralized-package-migration-summary.md (NuGet CPM migration - complete)
  • RUST_MODERNIZATION_SUMMARY.md (workspace unification - complete)
  • TEST_UPDATES_SUMMARY.md (xUnit test updates - complete)
  • ENVIRONMENT_VARIABLE_MIGRATION.md (env var standardization - complete)
  • oop-refactoring-next-steps.md (PowerShell OOP plan - historical)

Duplicate Directory Removal

  • Deleted src/shell-scripts/ (identical copy of src/shell/)
  • Deleted src/powershell-modules/ (identical copy of src/powershell/)
  • Removed nested duplicates: src/shell/{bash/bash/,zsh/zsh/}

Result: Documentation now matches actual repository structure. Historical migration docs preserved but clearly separated from active documentation.

Original prompt

On README.md, Clean up all the documentation files, make sure all documentation is current and delete anything out of date.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI self-assigned this Dec 30, 2025
Copilot AI and others added 2 commits December 30, 2025 05:57
Updated all references from src/rules-compiler-shell/ to src/shell/
Removed non-existent Windows Batch and PowerShell script references from shell scripts section

Co-authored-by: jaypatrick <1800595+jaypatrick@users.noreply.github.com>
- Moved completed migration/summary docs to docs/archive/
- Created archive README explaining historical documents
- Removed duplicate shell directories (shell-scripts, nested bash/bash, zsh/zsh)
- Removed duplicate powershell-modules directory
- Updated references in README and centralized-package-quick-reference

Co-authored-by: jaypatrick <1800595+jaypatrick@users.noreply.github.com>
Updated all references from deprecated paths to current paths:
- src/rules-compiler-shell/ → src/shell/
- src/shell-scripts/ → src/shell/
- src/powershell-modules/ → src/powershell/

Updated files: README.md, docs/README.md, docs/ENVIRONMENT_VARIABLES.md,
docs/compiler-comparison.md, docs/docker-guide.md, docs/getting-started.md

Co-authored-by: jaypatrick <1800595+jaypatrick@users.noreply.github.com>
@github-actions github-actions bot added documentation Improvements or additions to documentation configuration powershell shell labels Dec 30, 2025
Copy link
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 pull request cleans up the repository documentation and removes duplicate/outdated code. The main goals are to update paths to reflect the correct shell script locations, remove deprecated directories, archive historical documentation, and ensure consistency across the codebase.

Key Changes

  • Updated shell script paths from src/rules-compiler-shell/ and src/shell-scripts/ to the canonical src/shell/ location
  • Removed duplicate shell script files from incorrect directory structures
  • Created docs/archive/ directory for historical migration and implementation tracking documents
  • Updated documentation references to use correct paths

Reviewed changes

Copilot reviewed 35 out of 42 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/shell/zsh/zsh/compile-rules.zsh Removed duplicate zsh script (canonical version in src/shell/zsh/)
src/shell/zsh/zsh/README.md Removed duplicate documentation
src/shell/bash/bash/compile-rules.sh Removed duplicate bash script
src/shell-scripts/* Removed deprecated shell-scripts directory structure
src/powershell-modules/* Removed duplicate PowerShell modules (canonical in src/powershell/)
docs/archive/* Created archive directory for completed migration documentation
docs/AGENTS.md Updated path from src/rules-compiler-shell/ to src/shell/
README.md Updated multiple paths and removed outdated references
docs/centralized-package-quick-reference.md Updated to reference archived migration summary

Copilot AI changed the title [WIP] Clean up documentation in README.md Clean up documentation: fix outdated paths and archive completed migration docs Dec 30, 2025
Copilot AI requested a review from jaypatrick December 30, 2025 06:05
@jaypatrick jaypatrick marked this pull request as ready for review December 30, 2025 06:07
@jaypatrick jaypatrick merged commit 80c8713 into main Dec 30, 2025
9 checks passed
@jaypatrick jaypatrick deleted the copilot/clean-up-documentation-files branch December 30, 2025 06:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

configuration documentation Improvements or additions to documentation powershell shell

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants