Remove redundant docs directories - #157
Merged
Merged
Conversation
Owner
|
@james-in-a-box review this and ensure these documents weren't needed or were out of date. See if there are any other docs you can remove or clean up as well. |
Update references in README.md, action/README.md, gateway/README.md, sandbox/README.md, config/README.md, gateway/setup.sh, config/secrets.template.env, and sandbox/egg_lib/setup_flow.py to point to valid documentation after removal of redundant docs. Authored-by: egg
![james-in-a-box[bot]](https://avatars.githubusercontent.com/u/8340608?s=60&v=4){kind=small}
Contributor
Author
There was a problem hiding this comment.
Review Complete
I've reviewed the deleted documentation and verified the changes. Here's my assessment:
Deleted Documents Assessment
| Document | Verdict | Reason |
|---|---|---|
docs/setup/ |
✅ Appropriate to delete | Content duplicated in README.md, CONTRIBUTING.md, and ./setup.py |
docs/features/container-infrastructure.md |
✅ Appropriate to delete | Content duplicated in sandbox/README.md |
docs/features/github-action.md |
✅ Appropriate to delete | Content duplicated in action/README.md and the ADR |
docs/guides/mention-trigger-setup.md |
✅ Appropriate to delete | Workflow exists in .github/workflows/on-mention.yml; script comments provide context |
docs/reference/ |
✅ Appropriate to delete | Log persistence docs were niche and unused |
docs/troubleshooting/ |
GitHub auth troubleshooting was useful, but gateway/README.md and ADRs cover token refresh | |
docs/plans/ |
✅ Appropriate to delete | Implementation plan is obsolete (feature implemented) |
docs/development/README.md |
✅ Appropriate to delete | Duplicated CONTRIBUTING.md |
Broken Links Fixed
The PR had broken links in several files that referenced the deleted docs. I've fixed these in commit 3fe0add:
- README.md: Updated Documentation section and GitHub Action reference
- action/README.md: Updated to point to ADR and existing workflow files
- gateway/README.md: Removed broken troubleshooting link
- sandbox/README.md: Removed broken container-infrastructure link
- config/README.md: Updated GitHub App reference
- config/secrets.template.env: Updated comment reference
- gateway/setup.sh: Updated comment reference
- sandbox/egg_lib/setup_flow.py: Updated to point to GitHub's official docs
No Additional Cleanup Needed
The remaining documentation structure is clean and well-organized:
docs/index.md- Navigation hub (75 lines)docs/README.md- Intro (45 lines)docs/architecture/README.md- System design (55 lines)docs/development/STRUCTURE.md- Code organization (127 lines)docs/adr/- Architecture Decision Records (~9,400 lines total, all essential)
LGTM with the broken link fixes I've added.
— Authored by egg
Contributor
Author
|
egg finished successfully. View run logs |
jwbron
approved these changes
Feb 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Remove stale and redundant documentation directories that duplicated
information already covered by ADRs, component READMEs, and the main
README. This trims ~1,450 lines of docs that were drifting out of sync
with the actual codebase.
Deleted directories: troubleshooting/, setup/, reference/, plans/,
features/, guides/, and development/README.md. Updated docs/index.md
and docs/README.md to remove broken links.
Issue: none
Test plan:
Authored-by: egg