-
Notifications
You must be signed in to change notification settings - Fork 162
fix(docs): broken links in Authorization Endpoint (#12243) #12745
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
fix(docs): broken links in Authorization Endpoint (#12243) #12745
Conversation
Signed-off-by: Vinayak Mohanty <[email protected]>
📝 WalkthroughWalkthroughThis PR updates three broken documentation links in the Authorization Endpoint to point to the correct janssen-server and script-catalog locations; no runtime or functional code changes were made. You better think twice — links look fixed; please verify locally that they resolve. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (3)📓 Common learnings📚 Learning: 2025-11-19T12:55:01.596ZApplied to files:
📚 Learning: 2025-10-30T15:21:12.720ZApplied to files:
🔇 Additional comments (1)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/janssen-server/auth-server/endpoints/authorization.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: ossdhaval
Repo: JanssenProject/jans PR: 12539
File: docs/janssen-server/auth-server/client-management/software-statements.md:29-29
Timestamp: 2025-10-30T15:21:12.720Z
Learning: In the Janssen Project documentation (docs/ directory), relative links in markdown files work correctly when tested locally even when intermediate directory segments like "janssen-server" appear to be missing from the relative path. The documentation build system handles path resolution appropriately, so local testing by developers is authoritative for verifying link correctness.
Learnt from: yuriyz
Repo: JanssenProject/jans PR: 12596
File: docs/janssen-server/auth-server/tokens/oauth-tx-tokens.md:146-257
Timestamp: 2025-11-19T12:55:01.596Z
Learning: In the Janssen project, the TxToken custom script documentation is intentionally duplicated in both `docs/janssen-server/auth-server/tokens/oauth-tx-tokens.md` and `docs/script-catalog/tx_token/txtoken.md` to provide easy access from both the transaction token documentation and the script catalog.
📚 Learning: 2025-11-19T12:55:01.596Z
Learnt from: yuriyz
Repo: JanssenProject/jans PR: 12596
File: docs/janssen-server/auth-server/tokens/oauth-tx-tokens.md:146-257
Timestamp: 2025-11-19T12:55:01.596Z
Learning: In the Janssen project, the TxToken custom script documentation is intentionally duplicated in both `docs/janssen-server/auth-server/tokens/oauth-tx-tokens.md` and `docs/script-catalog/tx_token/txtoken.md` to provide easy access from both the transaction token documentation and the script catalog.
Applied to files:
docs/janssen-server/auth-server/endpoints/authorization.md
📚 Learning: 2025-10-30T15:21:12.720Z
Learnt from: ossdhaval
Repo: JanssenProject/jans PR: 12539
File: docs/janssen-server/auth-server/client-management/software-statements.md:29-29
Timestamp: 2025-10-30T15:21:12.720Z
Learning: In the Janssen Project documentation (docs/ directory), relative links in markdown files work correctly when tested locally even when intermediate directory segments like "janssen-server" appear to be missing from the relative path. The documentation build system handles path resolution appropriately, so local testing by developers is authoritative for verifying link correctness.
Applied to files:
docs/janssen-server/auth-server/endpoints/authorization.md
Signed-off-by: Vinayak Mohanty <[email protected]>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/janssen-server/auth-server/endpoints/authorization.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: ossdhaval
Repo: JanssenProject/jans PR: 12539
File: docs/janssen-server/auth-server/client-management/software-statements.md:29-29
Timestamp: 2025-10-30T15:21:12.720Z
Learning: In the Janssen Project documentation (docs/ directory), relative links in markdown files work correctly when tested locally even when intermediate directory segments like "janssen-server" appear to be missing from the relative path. The documentation build system handles path resolution appropriately, so local testing by developers is authoritative for verifying link correctness.
Learnt from: yuriyz
Repo: JanssenProject/jans PR: 12596
File: docs/janssen-server/auth-server/tokens/oauth-tx-tokens.md:146-257
Timestamp: 2025-11-19T12:55:01.596Z
Learning: In the Janssen project, the TxToken custom script documentation is intentionally duplicated in both `docs/janssen-server/auth-server/tokens/oauth-tx-tokens.md` and `docs/script-catalog/tx_token/txtoken.md` to provide easy access from both the transaction token documentation and the script catalog.
📚 Learning: 2025-11-19T12:55:01.596Z
Learnt from: yuriyz
Repo: JanssenProject/jans PR: 12596
File: docs/janssen-server/auth-server/tokens/oauth-tx-tokens.md:146-257
Timestamp: 2025-11-19T12:55:01.596Z
Learning: In the Janssen project, the TxToken custom script documentation is intentionally duplicated in both `docs/janssen-server/auth-server/tokens/oauth-tx-tokens.md` and `docs/script-catalog/tx_token/txtoken.md` to provide easy access from both the transaction token documentation and the script catalog.
Applied to files:
docs/janssen-server/auth-server/endpoints/authorization.md
Signed-off-by: Vinayak Mohanty <[email protected]>
Description
This PR fixes multiple broken documentation links on the Authorization Endpoint page.
The incorrect relative paths were causing 404 errors when navigating through the documentation.
Target Issue
closes #12243
Implementation Details
Updated the Interception Scripts link:
../../developer/interception-scripts.md→
../../../janssen-server/developer/scripts/README.mdUpdated the Person Authentication link:
../../developer/scripts/person-authentication.md→
../../../script-catalog/person_authentication/person-authentication.mdUpdated the Consent Gathering link:
../../developer/scripts/consent-gathering.md→
../../../script-catalog/consent_gathering/consent-gathering.mdAll modified links were verified locally using
mkdocs serve, ensuring no 404 errors remain.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.