Skip to content

Add navigation links to compliance docs#1275

Merged
spoorcc merged 1 commit into
mainfrom
claude/compliance-docs-links-rwbm6e
Jun 16, 2026
Merged

Add navigation links to compliance docs#1275
spoorcc merged 1 commit into
mainfrom
claude/compliance-docs-links-rwbm6e

Conversation

@spoorcc

@spoorcc spoorcc commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

All control IDs (C-001..C-046) in compliance_track.rst now link to their
anchored entries in control_register.rst. File paths in the Reference
column of control_register.rst link to their source on GitHub. Doc
paths use :doc: cross-references. SECURITY.md and OSCAL artefact
references throughout compliance_track.rst and security.rst link
directly to the relevant GitHub pages.

https://claude.ai/code/session_01DhTruTejopMJeFWfBKUtud

Summary by CodeRabbit

  • Documentation
    • Enhanced cross-references across compliance and control documentation for improved navigation between related content
    • Converted control identifiers and artifact paths to interactive links, increasing accessibility
    • Improved traceability of compliance controls and standards references throughout documentation
    • Strengthened connections between security and compliance documentation for clearer relationships

All control IDs (C-001..C-046) in compliance_track.rst now link to their
anchored entries in control_register.rst. File paths in the Reference
column of control_register.rst link to their source on GitHub. Doc
paths use :doc: cross-references. SECURITY.md and OSCAL artefact
references throughout compliance_track.rst and security.rst link
directly to the relevant GitHub pages.

https://claude.ai/code/session_01DhTruTejopMJeFWfBKUtud
@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 36032bc1-950e-4fae-bb46-7c055137087b

📥 Commits

Reviewing files that changed from the base of the PR and between 7812ca7 and 6e5d55d.

📒 Files selected for processing (3)
  • doc/explanation/compliance_track.rst
  • doc/explanation/control_register.rst
  • doc/explanation/security.rst

Walkthrough

Three RST documentation files are updated with no logic changes. control_register.rst gains .. _c-XXX: anchor labels for all controls (C-001–C-046) and reformats the Reference column to use GitHub URLs and :doc: roles. compliance_track.rst and security.rst replace plain control IDs and code literals with Sphinx :ref: cross-references and inline GitHub hyperlinks.

Changes

Compliance Documentation Cross-Reference Update

Layer / File(s) Summary
Control Register: per-control anchors and reformatted References
doc/explanation/control_register.rst
Adds .. _c-XXX: anchor labels for every control (C-001 through C-046) and rewrites the Reference column from plain file paths to GitHub source URLs, :doc: cross-references, and em-dash placeholders.
compliance_track.rst: :ref: links and GitHub URLs
doc/explanation/compliance_track.rst
Converts OSCAL artifact bullets, Applicable Standards rows, Part I (ECR-A through ECR-M) control cells, Part II (§1–§7) control cells, and Gap Analysis headings/bullets from plain text to :ref: cross-references and inline GitHub hyperlinks.
security.rst: :ref: links and OSCAL hyperlinks
doc/explanation/security.rst
Converts the three compliance-only control bullets (C-043, C-044, C-046) from bold labels to :ref: links, changes OSCAL artifact filenames from inline code to GitHub hyperlinks, and updates the security/README.md reference to a linked form.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • dfetch-org/dfetch#1271: Touches the same three documentation files (compliance_track.rst, security.rst, control_register.rst) and the same C-043/C-044/C-046 control references being re-linked in this PR.
  • dfetch-org/dfetch#1181: Introduced the CRA compliance/control references in doc/explanation/security.rst that this PR converts to :ref: links.
  • dfetch-org/dfetch#1272: Modifies the same Track B control listings in compliance_track.rst and security.rst, including the C-043/C-044/C-046 entries now being cross-linked here.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title accurately summarizes the main objective of adding navigation links to compliance documentation, which aligns with the primary changes throughout all modified compliance-related files.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/compliance-docs-links-rwbm6e

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 and usage tips.

@spoorcc spoorcc merged commit bb1c171 into main Jun 16, 2026
36 checks passed
@spoorcc spoorcc deleted the claude/compliance-docs-links-rwbm6e branch June 16, 2026 06:22
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