chore: remove 22 stale documentation files#173
Conversation
Remove one-off reports, superseded guides, and historical sprint artifacts that no longer reflect the current state of the project. All content is preserved in git history. Remaining docs: README, CHANGELOG, CLAUDE, CONTRIBUTING, SECURITY, PRODUCTION, TESTING, DXT-MULTISITE-GUIDE. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR deletes 22 obsolete markdown documentation artifacts from the repo root to reduce clutter and ensure only up‑to‑date docs remain, without touching any source code. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
This PR removes a large set of root-level Markdown documents (status reports, audits, roadmaps, and internal summaries), likely to reduce repo noise and eliminate stale/auto-generated content.
Changes:
- Deleted multiple historical/auto-generated reports and summaries (VS Code setup, test fix reports, sprint summaries, audits).
- Removed testing/coverage strategy docs and other internal planning/architecture docs from the repository root.
- Reduced documentation surface area by dropping several one-off “final report” style files.
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| VSCODE-SETUP-SUMMARY.md | Deleted VS Code setup quick summary document. |
| VSCODE-SETUP-REPORT.md | Deleted detailed VS Code setup report document. |
| TODO.md | Deleted project TODO/roadmap document. |
| TESTING_GUIDELINES.md | Deleted comprehensive testing guidelines document. |
| TEST_FIXES_SUMMARY.md | Deleted summary of test fixes document. |
| SPRINT_SUMMARY.md | Deleted sprint implementation summary document. |
| SEO_TOOL_ROADMAP.md | Deleted SEO toolkit roadmap document. |
| SECURITY_AUDIT_REPORT.md | Deleted dependency/security audit report document. |
| PRD.md | Deleted SEO toolkit PRD document. |
| MEMORY_FIX_REPORT.md | Deleted report about test memory error fix document. |
| LOG-ANALYSIS.md | Deleted Claude Desktop log analysis document. |
| IMPLEMENTATION_COMPLETE.md | Deleted “implementation complete” sprint report document. |
| FIXES_APPLIED.md | Deleted fixes-applied report document. |
| FINAL-FIX-REPORT.md | Deleted final DXT fix report document. |
| EXCLUDED_TESTS.md | Deleted excluded tests tracking document. |
| DXT-FIX-SUMMARY.md | Deleted DXT fix summary document. |
| DXT-ANALYSIS.md | Deleted DXT multi-site analysis document. |
| COVERAGE_STRATEGY.md | Deleted test coverage strategy document. |
| CORRECTED-FINAL-REPORT.md | Deleted corrected final DXT report document. |
| COMPOSITION_MIGRATION_GUIDE.md | Deleted composition migration guide document. |
| CI_FIX_REPORT.md | Deleted CI/CD fix report document. |
| ARCHITECTURAL_IMPROVEMENTS.md | Deleted architectural improvements summary document. |
Comments suppressed due to low confidence (2)
TESTING_GUIDELINES.md:1
- This file is removed, but it is still referenced from other repo docs (CONTRIBUTING.md links to TESTING_GUIDELINES.md; tests/QUICK_REFERENCE.md links to it and its troubleshooting anchor). Either keep/move this document or update those references in the same PR to avoid broken links.
COVERAGE_STRATEGY.md:1 - This file is removed, but it is still referenced from other repo docs (CONTRIBUTING.md and tests/QUICK_REFERENCE.md both link to COVERAGE_STRATEGY.md). Please either keep/move it or update those references in the same PR to avoid broken links.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d18426d8cd
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -1,760 +0,0 @@ | |||
| # Testing Guidelines & Best Practices | |||
There was a problem hiding this comment.
Deleting this file leaves live links pointing to a missing document, so contributor docs now contain dead references: CONTRIBUTING.md:696 links to TESTING_GUIDELINES.md, and tests/QUICK_REFERENCE.md:235,242 links to ../TESTING_GUIDELINES.md (including the troubleshooting anchor). This regression breaks onboarding/help flows for anyone following those docs unless the links are updated or redirected in the same change.
Useful? React with 👍 / 👎.
| @@ -1,346 +0,0 @@ | |||
| # Test Coverage Strategy | |||
There was a problem hiding this comment.
Removing this file also introduces dead documentation links that were not updated in the same commit: CONTRIBUTING.md:697 still references COVERAGE_STRATEGY.md, and tests/QUICK_REFERENCE.md:236 links to ../COVERAGE_STRATEGY.md. As a result, contributors following the documented testing workflow lose access to the referenced coverage guidance.
Useful? React with 👍 / 👎.
|
🎉 This PR is included in version 3.1.13 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Summary
Removed: ARCHITECTURAL_IMPROVEMENTS, CI_FIX_REPORT, COMPOSITION_MIGRATION_GUIDE, CORRECTED-FINAL-REPORT, COVERAGE_STRATEGY, DXT-ANALYSIS, DXT-FIX-SUMMARY, EXCLUDED_TESTS, FINAL-FIX-REPORT, FIXES_APPLIED, IMPLEMENTATION_COMPLETE, LOG-ANALYSIS, MEMORY_FIX_REPORT, PRD, SECURITY_AUDIT_REPORT, SEO_TOOL_ROADMAP, SPRINT_SUMMARY, TEST_FIXES_SUMMARY, TESTING_GUIDELINES, TODO, VSCODE-SETUP-REPORT, VSCODE-SETUP-SUMMARY
Kept: README, CHANGELOG, CLAUDE, CONTRIBUTING, SECURITY, PRODUCTION, TESTING, DXT-MULTISITE-GUIDE
Test plan
🤖 Generated with Claude Code
Summary by Sourcery
Documentation: