Skip to content

OSAC-4008: Delete unused reference/*.md files and vestigial .ai-bot/ config, symlink survivors to osac/docs/ - #217

Merged
tchughesiv merged 1 commit into
osac-project:mainfrom
tchughesiv:OSAC-4008-cleanup-unused-reference-docs
Aug 18, 2026
Merged

tchughesiv merged 1 commit into
osac-project:mainfrom
tchughesiv:OSAC-4008-cleanup-unused-reference-docs

Conversation

@tchughesiv

@tchughesiv tchughesiv commented Aug 17, 2026 •

Copy link
Copy Markdown
Contributor

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/*.md codebase-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 companion osac PR's new osac/docs/ location, preserving the exact relative paths AGENTS.md and the design-review/prd-review skills already use — zero changes needed to those consumers. Also deletes osac-workspace/.ai-bot/, vestigial since OSAC-3487 consolidated per-component bot configs into osac/.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 /ingest pass)
  • 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/) — deleted
  • AGENTS.md — corrected a stale claim that CONVENTIONS.md is "regenerated via repo-intel tooling, not hand-edited" (no longer true once this PR points it at a hand-trimmed file)

Testing

  • Unit tests: N/A (repo-layout change, no executable surface)
  • Integration tests: N/A
  • Coverage: Verified the two symlinks resolve to real content (cat reference/ARCHITECTURE.md, cat reference/CONVENTIONS.md) once the companion osac PR's branch is locally present; confirmed via full-workspace grep that no reference to any of the 5 deleted files or .ai-bot/ remains anywhere

Acceptance Criteria

  • AC-1, AC-3 (this half — deletion/symlink; the companion osac PR 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 any osac-workspace user whose osac/ checkout is at its current released state.

Summary by CodeRabbit

  • Documentation
    • Removed several outdated internal reference documents covering architecture, integrations, technology stack, project structure, testing, conventions, and known concerns.
    • Updated documentation guidance to identify the conventions reference as a maintained excerpt.
    • Simplified bot instructions by removing a mandatory reference-reading step.

@openshift-ci-robot

openshift-ci-robot commented Aug 17, 2026 •

Copy link
Copy Markdown

@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.

Details

In response to this:

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/*.md codebase-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 companion osac PR's new osac/docs/ location, preserving the exact relative paths AGENTS.md and the design-review/prd-review skills already use — zero changes needed to those consumers. Also deletes osac-workspace/.ai-bot/, vestigial since OSAC-3487 consolidated per-component bot configs into osac/.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 /ingest pass)
  • 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/) — deleted
  • AGENTS.md — corrected a stale claim that CONVENTIONS.md is "regenerated via repo-intel tooling, not hand-edited" (no longer true once this PR points it at a hand-trimmed file)

Testing

  • Unit tests: N/A (repo-layout change, no executable surface)
  • Integration tests: N/A
  • Coverage: Verified the two symlinks resolve to real content (cat reference/ARCHITECTURE.md, cat reference/CONVENTIONS.md) once the companion osac PR's branch is locally present; confirmed via full-workspace grep that no reference to any of the 5 deleted files or .ai-bot/ remains anywhere

Acceptance Criteria

  • AC-1, AC-3 (this half — deletion/symlink; the companion osac PR 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 any osac-workspace user whose osac/ checkout is at its current released state.

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.

@openshift-ci

openshift-ci Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coderabbitai

coderabbitai Bot commented Aug 17, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: osac-project/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 36db7f30-5fb8-498b-961a-531209bc9bab

📥 Commits

Reviewing files that changed from the base of the PR and between d5a2ae7 and 67192f4.

📒 Files selected for processing (11)
  • .ai-bot/instructions.md
  • AGENTS.md
  • reference/ARCHITECTURE.md
  • reference/ARCHITECTURE.md
  • reference/CONCERNS.md
  • reference/CONVENTIONS.md
  • reference/CONVENTIONS.md
  • reference/INTEGRATIONS.md
  • reference/STACK.md
  • reference/STRUCTURE.md
  • reference/TESTING.md
💤 Files with no reviewable changes (6)
  • .ai-bot/instructions.md
  • reference/CONCERNS.md
  • reference/STACK.md
  • reference/INTEGRATIONS.md
  • reference/STRUCTURE.md
  • reference/TESTING.md

Included review availability: Your plan includes up to 1 review per rolling hour; 0 remain after this review.


Walkthrough

The pull request removes obsolete reference documentation, deletes the architecture, concerns, conventions, integrations, stack, structure, and testing files, and updates the conventions reference description in AGENTS.md.

Changes

Reference documentation cleanup

Layer / File(s) Summary
Remove obsolete reference documents
AGENTS.md, reference/*.md
Deleted obsolete reference documents and updated AGENTS.md to describe reference/CONVENTIONS.md as a hand-trimmed excerpt symlinked to osac/docs/CONVENTIONS.md.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 67192

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: amej, itzikezra-rh, eranco74

🚥 Pre-merge checks | ✅ 11
✅ Passed checks (11 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
No-Hardcoded-Secrets ✅ Passed The PR adds only documentation text and two symlink targets; scans found no API keys, tokens, passwords, private keys, credential URLs, or long encoded blobs in added content.
No-Weak-Crypto ✅ Passed The diff only deletes Markdown, updates AGENTS.md, and adds symlinks; it introduces no MD5/SHA1/DES/RC4/Blowfish/ECB use, custom crypto, or secret comparison.
No-Injection-Vectors ✅ Passed The diff only deletes Markdown and changes two Markdown files to symlinks; the sole added prose contains no SQL, shell execution, eval/exec, unsafe YAML/pickle, or HTML injection pattern.
Container-Privileges ✅ Passed The PR changes only documentation, symlinks, and bot instructions. No container/Kubernetes manifest or added privilege setting appears in the diff.
No-Sensitive-Data-In-Logs ✅ Passed The parent diff changes only Markdown files, deletions, and two documentation symlinks; it adds no logging code or sensitive-data logging behavior.
Ai-Attribution ✅ Passed The sole PR commit includes Assisted-by: Claude Code <noreply@anthropic.com> and contains no Co-Authored-By marker.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the deletion of unused reference files and obsolete .ai-bot configuration, plus the symlink updates described in the objectives.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

…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>
@tchughesiv
tchughesiv force-pushed the OSAC-4008-cleanup-unused-reference-docs branch from 5d7fcb1 to 67192f4 Compare August 17, 2026 19:44
@tchughesiv
tchughesiv marked this pull request as ready for review August 17, 2026 19:58
@openshift-ci
openshift-ci Bot requested review from ItzikEzra-rh and amej August 17, 2026 19:58
@tchughesiv
tchughesiv marked this pull request as draft August 17, 2026 20:05
@tchughesiv
tchughesiv marked this pull request as ready for review August 18, 2026 15:05
@openshift-ci
openshift-ci Bot requested review from batzionb and jhernand August 18, 2026 15:06
@tchughesiv
tchughesiv merged commit 0e651b2 into osac-project:main Aug 18, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants