Skip to content

Conversation

@Vinayak9769
Copy link

@Vinayak9769 Vinayak9769 commented Nov 24, 2025

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.md
  • Updated the Person Authentication link:

    • ../../developer/scripts/person-authentication.md
      ../../../script-catalog/person_authentication/person-authentication.md
  • Updated the Consent Gathering link:

    • ../../developer/scripts/consent-gathering.md
      ../../../script-catalog/consent_gathering/consent-gathering.md

All modified links were verified locally using mkdocs serve, ensuring no 404 errors remain.

Summary by CodeRabbit

  • Documentation
    • Updated authorization endpoint docs to point to the relocated Interception Scripts references.
    • Updated example script links for person authentication and consent gathering to their new locations.
    • Changes applied consistently in the Interception Scripts customization section; no behavioral changes.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 24, 2025

📝 Walkthrough

Walkthrough

This 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

Cohort / File(s) Summary
Documentation Link Corrections
docs/janssen-server/auth-server/endpoints/authorization.md
Replaced three broken relative links: ../../developer/interception-scripts.md../../../janssen-server/developer/scripts/README.md; ../../developer/scripts/person-authentication.md../../../script-catalog/person_authentication/person-authentication.md; ../../developer/scripts/consent-gathering.md../../../script-catalog/consent_gathering/consent-gathering.md.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Verify the three updated links resolve to the intended documentation pages.

Possibly related issues

  • #12489 — Proposes the same fixes for the Interception Scripts and script-catalog links referenced on the Authorization Endpoint.

Possibly related PRs

Suggested labels

kind-bug, area-documentation, comp-docs

Suggested reviewers

  • manojs1978
  • ossdhaval

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: fixing broken documentation links in the Authorization Endpoint.
Description check ✅ Passed The description comprehensively covers all required sections: target issue, implementation details with specific link changes, and local verification evidence.
Linked Issues check ✅ Passed The PR successfully addresses all three link fixes specified in issue #12243 and confirms local testing via mkdocs serve as required.
Out of Scope Changes check ✅ Passed All changes are strictly documentation link corrections directly addressing the objectives in issue #12243 with no out-of-scope modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 48c6ab5 and fd5fbf8.

📒 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
🔇 Additional comments (1)
docs/janssen-server/auth-server/endpoints/authorization.md (1)

130-133: You better think twice! 🐦 All good—links are solid and grammar is chef's kiss!

Nice work! All three broken links have been corrected and will resolve properly from this file's location. The sentence structure is grammatically sound (plural subject "scripts" + plural verb "allow"), and the thought flows naturally through to completion ("can be customized using interception scripts").

The updated paths are correct:

  • ✅ Interception scripts: ../../../janssen-server/developer/scripts/README.md
  • ✅ Person authentication: ../../../script-catalog/person_authentication/person-authentication.md
  • ✅ Consent gathering: ../../../script-catalog/consent_gathering/consent-gathering.md

All previous review feedback has been addressed. Local verification via mkdocs serve confirms the links resolve without 404 errors.


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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between d6b9f40 and e0dc834.

📒 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]>
@mo-auto
Copy link
Member

mo-auto commented Nov 24, 2025

Snyk checks have passed. No issues have been found so far.

Status Scanner Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between e0dc834 and 48c6ab5.

📒 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]>
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.

fix(docs): broken link in the Authorization Endpoint

2 participants