docs: link post-it diagrams to API pages and adopt the generated triangle marker#623
Conversation
…ngle marker The committed post-it SVGs (architecture, storage, sl1-3) predated the generated relationship-diagram engine (S23.13) and had drifted from it. Bring them back in line and make them navigable. - Replace the old chevron "realises" marker with the hollow triangle from postit-defs.svg, matching the generated diagrams. - Link the green interface stickies, the SolidSyslog facade, and the Config sticky to their API compound pages via relative ../../api/... hrefs. Hover highlight is a darker shade of each sticky's own colour, as in the generated diagrams. Backend/Null/injected stickies stay unlinked. - Embed the SL diagrams on security-levels.md via <object> (with an <img> fallback) so the SVG's internal links stay clickable; a Markdown image cannot carry them. Scoped MD033 exception with an inline reason. Orientation left unchanged. Follows S23.13; part of E23. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
WalkthroughThe security-level documentation now embeds the existing SL1–SL3 SVG diagrams using HTML ChangesSecurity-level documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/security-levels.md`:
- Line 67: Update the fallback img paths paired with the SVG object elements in
docs/security-levels.md at lines 67-67, 81-81, and 96-96 to use the same
../assets/... relative path as their matching object data attributes, preserving
each asset filename.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 10ea6619-7c7a-437b-a7c0-c369d45ee50b
⛔ Files ignored due to path filters (6)
docs/assets/postit/architecture.svgis excluded by!**/*.svg,!**/*.svg,!docs/assets/**docs/assets/postit/sl1.svgis excluded by!**/*.svg,!**/*.svg,!docs/assets/**docs/assets/postit/sl2.svgis excluded by!**/*.svg,!**/*.svg,!docs/assets/**docs/assets/postit/sl3.svgis excluded by!**/*.svg,!**/*.svg,!docs/assets/**docs/assets/postit/storage.svgis excluded by!**/*.svg,!**/*.svg,!docs/assets/**docs/assets/stylesheets/brand.cssis excluded by!docs/assets/**
📒 Files selected for processing (1)
docs/security-levels.md
☀️ Quality Summary 🚦 build-linux-gcc: 100% successful (✔️ 1522 passed) Created by Quality Monitor v1.14.0 (#f3859fd). More details are shown in the GitHub Checks Result. |
What
The committed post-it SVGs (
architecture,storage,sl1–sl3) predated thegenerated relationship-diagram engine (S23.13) and had drifted from it. This brings the static hand-drawn diagrams back in line and makes them navigable, without changing their orientation.
Changes
realisesmarker with the hollow triangle frompostit-defs.svg, matching the generated diagrams.SolidSyslogfacade, and theConfigsticky now link to their API compound pages via relative../../api/…hrefs (27 links, all resolving to real pages). Backend/Null/injected stickies stay unlinked. Hover highlight is a darker shade of each sticky's own colour (green#6fae74, amber#b89a3c, rose#cf8a8a), matching the generated diagrams rather than the site-norm violet.security-levels.mdswitch from a Markdown image to<object>(with an<img>fallback for GitHub) so the SVG's internal links stay clickable; an<img>-loaded SVG swallows them. Relative link targets resolve within any deployment prefix, so versioned docs stay correct. ScopedMD033exception with an inline reason.Verification
markdownlint-cli2(the CI gate) is clean.mkdocs buildsucceeds; the rendered page emits<object data="../assets/postit/slN.svg">with the path intact, the copied SVGs carry the links + new marker, and all target pages exist.mkdocs serve: interface/facade/config boxes highlight and click through to the right API pages.Follows S23.13; part of E23 (#246).
🤖 Generated with Claude Code
Summary by CodeRabbit