Skip to content

docs: note hazard-analysis citations drift after the rag.ts decomposition — search by symbol#1000

Merged
BigSimmo merged 3 commits into
mainfrom
claude/maturity-docs-citation-reverify
Jul 20, 2026
Merged

docs: note hazard-analysis citations drift after the rag.ts decomposition — search by symbol#1000
BigSimmo merged 3 commits into
mainfrom
claude/maturity-docs-citation-reverify

Conversation

@BigSimmo

@BigSimmo BigSimmo commented Jul 20, 2026

Copy link
Copy Markdown
Owner

Summary

A one-line durability complement to the already-merged #998 (which refreshed the file:line citations in clinical-hazard-analysis.md and rag-injection-threat-model.md after the rag.tssrc/lib/rag/* decomposition).

#998 re-pinned the citations to their current locations, but left one absolute-currency claim in the hazard doc: line 14 said each control is "cited at its present location." That claim re-stales on every refactor (and docs:check-links only validates the file path, not the line — which is how the citations drifted unnoticed in the first place). This replaces it with an as-of-#998 note plus guidance to search by the named symbol when a line has shifted.

This PR was originally a parallel "as-of framing" pass over both docs; after #998 landed the exact re-pin, I rebased onto current main and reduced it to just this single non-redundant, non-conflicting line so it complements #998 rather than duplicating or contradicting it.

Diff: 1 file, 1 linedocs/clinical-hazard-analysis.md.

Verification

  • npm run docs:check-links — pass (991 refs resolve).
  • npm run format:check — pass.
  • Docs-only, single-line prose edit: no source/behaviour touched; unit/type/UI/eval gates N/A. No conflict with main.

Risk and rollout

  • Risk: negligible — one sentence of documentation guidance; no code, config, or analysis change.
  • Rollback: revert the PR.
  • Provider or production effects: None.

Clinical Governance Preflight

N/A — documentation-only edit to one analysis doc; no ingestion, answer generation, search/ranking, source rendering, document access, privacy, production-env, or clinical-output behaviour changed.

Notes

Broader durability option (separate pass, if wanted): switch the analysis docs' file:line citations to symbol + file references with no line number, which never go stale. Left as a future editorial decision.


Generated by Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified how audit findings correspond to reproduced defects and current remediation controls.
    • Updated citation guidance to reflect the reorganized retrieval source files and explain how to verify references after future changes.

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The clinical hazard analysis Method section now clarifies audit finding scope, remediation status, and symbol-based citation guidance after the RAG implementation decomposition.

Changes

RAG documentation references

Layer / File(s) Summary
Audit and symbol-reference guidance
docs/clinical-hazard-analysis.md
The Method section scopes H1–H4 to reproduced pathway defects, identifies PR #123 remediations as current controls, and documents updated file:line guidance for the decomposed RAG implementation.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 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.
Title check ✅ Passed The title clearly describes the docs-only citation-drift note after the rag.ts decomposition.
Description check ✅ Passed The description matches the template with Summary, Verification, Risk and rollout, Clinical Governance Preflight, and Notes filled appropriately.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/maturity-docs-citation-reverify

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

@supabase

supabase Bot commented Jul 20, 2026

Copy link
Copy Markdown

This pull request has been ignored for the connected project sjrfecxgysukkwxsowpy because there are no changes detected in supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.


Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

@BigSimmo
BigSimmo marked this pull request as ready for review July 20, 2026 17:07
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@BigSimmo
BigSimmo enabled auto-merge (squash) July 20, 2026 17:17
@BigSimmo
BigSimmo disabled auto-merge July 20, 2026 17:19
PR #998 (merged) already refreshed the file:line citations after the rag.ts
decomposition, so this trims the parallel #1000 down to the one durable
complement #998 left untouched: line 14 still claimed each control is "cited at
its present location" — an absolute-currency claim that re-stales on every
refactor. Replace it with an as-of-#998 note plus guidance to search by the
named symbol when a line has drifted (docs:check-links validates the path, not
the line).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019Jc1ZYHFjXjn6mE6U6riVU
@BigSimmo
BigSimmo force-pushed the claude/maturity-docs-citation-reverify branch from 5798512 to c9f8c45 Compare July 20, 2026 17:21
@BigSimmo BigSimmo changed the title docs: honestly frame stale file:line citations in the governance analysis docs docs: note hazard-analysis citations drift after the rag.ts decomposition — search by symbol Jul 20, 2026
@BigSimmo
BigSimmo enabled auto-merge (squash) July 20, 2026 20:48
@BigSimmo
BigSimmo merged commit 929f728 into main Jul 20, 2026
16 checks passed
@BigSimmo
BigSimmo deleted the claude/maturity-docs-citation-reverify branch July 20, 2026 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants