Repository navigation
OSAC-4008: Delete unused reference/*.md files and vestigial .ai-bot/ config, symlink survivors to osac/docs/ - #217
Conversation
|
@tchughesiv: This pull request references OSAC-4008 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "5.1.0" version, but no target version was set. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: tchughesiv The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: osac-project/coderabbit/.coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (11)
💤 Files with no reviewable changes (6)
Included review availability: Your plan includes up to 1 review per rolling hour; 0 remain after this review. WalkthroughThe pull request removes obsolete reference documentation, deletes the architecture, concerns, conventions, integrations, stack, structure, and testing files, and updates the conventions reference description in ChangesReference documentation cleanup
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This PR removes unused documentation and vestigial configuration while preserving the two referenced paths through symlinks; no actionable merge-blocking risk remains beyond normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 11✅ Passed checks (11 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
…config, symlink survivors to osac/docs/
CONCERNS.md, INTEGRATIONS.md, STACK.md, STRUCTURE.md, and TESTING.md have
zero live consumers anywhere in the workspace (re-verified via a targeted
per-filename grep, not just the initial ingest pass) -- deleted rather
than relocated.
ARCHITECTURE.md and CONVENTIONS.md are replaced with relative symlinks to
osac/docs/{ARCHITECTURE,CONVENTIONS}.md (trimmed excerpts added in a
companion osac PR), preserving the exact relative paths AGENTS.md and
skills/design-review, skills/prd-review already use -- zero changes needed
in those consumers. Also corrected AGENTS.md's now-stale claim that
CONVENTIONS.md's content is "regenerated via the repo-intel tooling, not
hand-edited" -- it's now a hand-trimmed excerpt.
.ai-bot/instructions.md (and the now-empty .ai-bot/ dir) is deleted as
vestigial: its only purpose was pointing a bot at reference/CONVENTIONS.md,
superseded by osac/.ai-bot/instructions.md's self-contained content since
OSAC-3487 consolidated per-component bot configs into osac/'s repo root.
Depends on the companion osac PR (adds osac/docs/{ARCHITECTURE,CONVENTIONS}.md)
merging first -- these symlinks are dangling until then.
Assisted-by: Claude Code <noreply@anthropic.com>
Signed-off-by: Tommy Hughes <tohughes@redhat.com>
5d7fcb1 to
67192f4
Compare
OSAC-4008: Delete unused reference/*.md files and vestigial .ai-bot/ config, symlink survivors to osac/docs/
Jira: https://redhat.atlassian.net/browse/OSAC-4008
Story type: [DEV]
Summary
Of the seven
reference/*.mdcodebase-analysis files, five (CONCERNS.md,INTEGRATIONS.md,STACK.md,STRUCTURE.md,TESTING.md) have zero live consumers anywhere in the workspace and are deleted outright. The remaining two (ARCHITECTURE.md,CONVENTIONS.md) are replaced with relative symlinks into the companionosacPR's newosac/docs/location, preserving the exact relative pathsAGENTS.mdand thedesign-review/prd-reviewskills already use — zero changes needed to those consumers. Also deletesosac-workspace/.ai-bot/, vestigial since OSAC-3487 consolidated per-component bot configs intoosac/.ai-bot/instructions.md.Changes
reference/CONCERNS.md,INTEGRATIONS.md,STACK.md,STRUCTURE.md,TESTING.md— deleted (re-verified zero live consumers via a targeted workspace-wide grep, beyond the initial/ingestpass)reference/ARCHITECTURE.md,reference/CONVENTIONS.md— replaced with relative symlinks to../osac/docs/ARCHITECTURE.md/../osac/docs/CONVENTIONS.md.ai-bot/instructions.md(+ now-empty.ai-bot/) — deletedAGENTS.md— corrected a stale claim thatCONVENTIONS.mdis "regenerated via repo-intel tooling, not hand-edited" (no longer true once this PR points it at a hand-trimmed file)Testing
cat reference/ARCHITECTURE.md,cat reference/CONVENTIONS.md) once the companionosacPR's branch is locally present; confirmed via full-workspace grep that no reference to any of the 5 deleted files or.ai-bot/remains anywhereAcceptance Criteria
osacPR covers the docs-content half)Related PRs
This ticket spans 3 repos and produces 4 PRs total. This PR must merge only after osac-project/osac#364 is merged — its two symlinks target files that only exist in
osac/once that PR lands. Merging this PR first would leave those two symlinks dangling for anyosac-workspaceuser whoseosac/checkout is at its current released state.osac-workspacePR (PR-A) in this ticketSummary by CodeRabbit