docs(oie-apis): fix relative link to Pane of Glass RFC - #1086
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review. Summary by CodeRabbit
WalkthroughThe documentation updates the OIE design RFC link to use the correct relative path. ChangesDocumentation Link Correction
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Severity of issue fixed: Low Merge Risk: ⚪ Minimal · up to The API documentation now links to the existing Pane of Glass RFC at the correct relative path. This is a documentation-only correction with no remaining merge-readiness risk. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
The OIE module handover APIs README links the RFC as ../designs/owasp-pane-of-glass.md, which from docs/owasp-graph/apis/ resolves to docs/owasp-graph/designs/owasp-pane-of-glass.md and 404s. The file lives at docs/designs/owasp-pane-of-glass.md, one level higher, as docs/owasp-graph/README.md already links it correctly. Add the missing ../ so the link resolves.
998708c to
84ec64a
Compare
What
docs/owasp-graph/apis/README.mdlinks the Pane of Glass RFC as../designs/owasp-pane-of-glass.md. Fromdocs/owasp-graph/apis/thatn resolves todocs/owasp-graph/designs/owasp-pane-of-glass.md, which doesnot exist, so the link 404s.
The file is at
docs/designs/owasp-pane-of-glass.md— one directory higher. The siblingdocs/owasp-graph/README.mdalready links it correctly with../designs/...because it sits one level up.Fix
Add the missing
../so the link points at../../designs/owasp-pane-of-glass.md.Validation
Checked locally that the corrected path resolves to the existing file and that no other doc references the broken path.