Skip to content

doc: fix diagram syntax error and move pipeline meta-docs to separate page#1277

Merged
spoorcc merged 1 commit into
mainfrom
claude/security-docs-diagram-restructure-pze8qk
Jun 16, 2026
Merged

doc: fix diagram syntax error and move pipeline meta-docs to separate page#1277
spoorcc merged 1 commit into
mainfrom
claude/security-docs-diagram-restructure-pze8qk

Conversation

@spoorcc

@spoorcc spoorcc commented Jun 16, 2026

Copy link
Copy Markdown
Contributor
  • Fix PlantUML syntax error in security_doc_flow.puml: replace unsupported
    #line.dashed;back:color combined style (not available in plantuml ≤2020)
    with a stereotype-based skinparam block (skinparam package<<assess>>)
  • Move the "Security Documentation Pipeline" section out of security.rst
    into a new security_pipeline.rst, so the security model page focuses on
    the model itself rather than implementation details
  • Add a brief cross-reference paragraph and toctree entry in security.rst
    pointing to the new page

https://claude.ai/code/session_01QfePU2NybeWt7GnCiZg42s

Summary by CodeRabbit

  • Documentation
    • Enhanced security documentation with a comprehensive guide to security and compliance pipelines, including threat-model components, compliance tracking processes, and release verification artifacts
    • Updated visual diagrams to improve clarity of security pipeline workflows

… page

- Fix PlantUML syntax error in security_doc_flow.puml: replace unsupported
  `#line.dashed;back:color` combined style (not available in plantuml ≤2020)
  with a stereotype-based skinparam block (`skinparam package<<assess>>`)
- Move the "Security Documentation Pipeline" section out of security.rst
  into a new security_pipeline.rst, so the security model page focuses on
  the model itself rather than implementation details
- Add a brief cross-reference paragraph and toctree entry in security.rst
  pointing to the new page

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

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 46a99a07-11ef-4d44-93b6-9946d8cf9d56

📥 Commits

Reviewing files that changed from the base of the PR and between 91b13e3 and 623c42a.

📒 Files selected for processing (3)
  • doc/explanation/security.rst
  • doc/explanation/security_pipeline.rst
  • doc/static/uml/security_doc_flow.puml

Walkthrough

The inline "Security Documentation Pipeline" section in security.rst is removed and replaced by a cross-reference note and toctree entry pointing to a new security_pipeline.rst page. The new page documents the threat-model pipeline, compliance pipeline, release attestations, dependency-scanning outputs, and an artifact summary table. The PlantUML diagram gains a skinparam package<<assess>> rule that replaces prior inline styling on the p_assess package.

Changes

Security Pipeline Documentation Refactor

Layer / File(s) Summary
New security_pipeline.rst page
doc/explanation/security_pipeline.rst
Adds a 121-line RST page describing the threat-model pipeline (tm_supply_chain.py, tm_usage.py, threats.json, tm_render.py), compliance pipeline (compliance_data.py, compliance.py, OSCAL JSON), release attestations, dependency-scanning outputs (SARIF/Code Climate/Jenkins), and an "Artifacts at a glance" list-table.
security.rst cross-reference and toctree update
doc/explanation/security.rst
Replaces 112 lines of inline pipeline content with a 4-line note referencing security_pipeline, and adds security_pipeline to the Sphinx toctree under "Threat Models".
PlantUML assess package stereotype styling
doc/static/uml/security_doc_flow.puml
Adds a global skinparam package<<assess>> block setting background color and dashed border; updates the p_assess package declaration to use <<assess>> stereotype instead of inline #line.dashed;back: modifiers.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • dfetch-org/dfetch#1181: Modifies the same doc/explanation/security.rst file, introducing the product security context content that this PR now partially replaces with a cross-reference.
  • dfetch-org/dfetch#1276: Directly overlaps by modifying both doc/explanation/security.rst and doc/static/uml/security_doc_flow.puml for the pipeline section and diagram that this PR refactors.
🚥 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 title accurately summarizes the two main changes: fixing a PlantUML diagram syntax error and reorganizing pipeline documentation into a separate page.
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/security-docs-diagram-restructure-pze8qk

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 b721b05 into main Jun 16, 2026
36 checks passed
@spoorcc spoorcc deleted the claude/security-docs-diagram-restructure-pze8qk branch June 16, 2026 17: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