Skip to content

docs(oie-apis): fix relative link to Pane of Glass RFC - #1086

Open
ajmani-x wants to merge 1 commit into
OWASP:mainfrom
ajmani-x:docs/fix-oie-apis-rfc-link
Open

docs(oie-apis): fix relative link to Pane of Glass RFC#1086
ajmani-x wants to merge 1 commit into
OWASP:mainfrom
ajmani-x:docs/fix-oie-apis-rfc-link

Conversation

@ajmani-x

@ajmani-x ajmani-x commented Sep 8, 2026

Copy link
Copy Markdown

What

docs/owasp-graph/apis/README.md links the Pane of Glass RFC as ../designs/owasp-pane-of-glass.md. From docs/owasp-graph/apis/ thatn resolves to docs/owasp-graph/designs/owasp-pane-of-glass.md, which does
not exist, so the link 404s.

The file is at docs/designs/owasp-pane-of-glass.md — one directory higher. The sibling docs/owasp-graph/README.md already 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.

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Advanced

Run ID: 39d85462-0c35-4854-8065-a0c5fe11a00b

📥 Commits

Reviewing files that changed from the base of the PR and between 5a3c384 and 998708c.

📒 Files selected for processing (1)
  • docs/owasp-graph/apis/README.md

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


Summary by CodeRabbit

  • Documentation
    • Corrected the link to the OIE design RFC so it resolves properly from the API documentation.

Walkthrough

The documentation updates the OIE design RFC link to use the correct relative path.

Changes

Documentation Link Correction

Layer / File(s) Summary
RFC link path update
docs/owasp-graph/apis/README.md
Corrects the relative path from ../designs/owasp-pane-of-glass.md to ../../designs/owasp-pane-of-glass.md.

Priority: ⬇️ Low

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

Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to 84ec6

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)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Description check ✅ Passed The description accurately explains the broken relative link, the path correction, and the validation performed.
Title check ✅ Passed The title clearly and concisely identifies the documentation change and the corrected relative link.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

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.
@ajmani-x
ajmani-x force-pushed the docs/fix-oie-apis-rfc-link branch from 998708c to 84ec64a Compare September 8, 2026 19:04
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.

1 participant