fix(docs): fix broken links in Authorization Endpoint documentation #12749
Conversation
Fixed two broken links that were throwing 404 errors: - Updated Interception scripts link path - Updated person authentication link path Fixes JanssenProject#12243 Signed-off-by: Sivasai <[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. |
📝 WalkthroughYo, check it out! Here's what we're cookin' with today: WalkthroughThis PR fixes broken documentation links in the Authorization Endpoint page by updating relative paths to point to correct locations in the newly restructured script-catalog and janssen-server directories. Three links are corrected to resolve 404 errors. 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❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 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
🪛 LanguageTool
docs/janssen-server/auth-server/endpoints/authorization.md
[style] ~138-~138: ‘in the meantime’ might be wordy. Consider a shorter alternative.
Context: ...t you'd like to contribute to this page in the meantime, you can get started with our [Contribu...
(EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)
🪛 markdownlint-cli2 (0.18.1)
docs/janssen-server/auth-server/endpoints/authorization.md
133-133: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
🔇 Additional comments (1)
docs/janssen-server/auth-server/endpoints/authorization.md (1)
138-138: Verify the Contribution guide URL change.The Contribution guide link (line 138) was changed from a relative path to an absolute URL (
https://docs.jans.io/head/CONTRIBUTING/). This is a stylistic departure from the other relative links in the file. Please confirm this is intentional — does the external URL provide a better user experience, or should this remain as a relative path for consistency with the rest of the documentation?
| [Interception scripts](../../../janssen-server/developer/scripts/README.md) allows | ||
| flexibility to configure and customize multiple aspects in Janssen Server. For example, see this documentation to learn | ||
| how [person authentication](../../developer/scripts/person-authentication.md) | ||
| how [person authentication](../../../script-catalog/person_authentication/person-authentication.md) | ||
| and [consent gathering](../../developer/scripts/consent-gathering.md) can be | ||
| customized using interception scripts. |
There was a problem hiding this comment.
🚨 Critical: Incomplete link fixes — consent gathering link not updated.
Per PR objectives and linked issue #12243, three broken links should be fixed. The Interception scripts (line 130) and person authentication (line 132) links have been correctly updated, but the consent gathering link (line 133) still points to the broken path ../../developer/scripts/consent-gathering.md. According to the issue, it should be updated to ../../../script-catalog/consent_gathering/consent-gathering.md.
Apply this diff to complete the fix:
-[consent gathering](../../developer/scripts/consent-gathering.md) can be
+[consent gathering](../../../script-catalog/consent_gathering/consent-gathering.md) can be 📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [Interception scripts](../../../janssen-server/developer/scripts/README.md) allows | |
| flexibility to configure and customize multiple aspects in Janssen Server. For example, see this documentation to learn | |
| how [person authentication](../../developer/scripts/person-authentication.md) | |
| how [person authentication](../../../script-catalog/person_authentication/person-authentication.md) | |
| and [consent gathering](../../developer/scripts/consent-gathering.md) can be | |
| customized using interception scripts. | |
| [Interception scripts](../../../janssen-server/developer/scripts/README.md) allows | |
| flexibility to configure and customize multiple aspects in Janssen Server. For example, see this documentation to learn | |
| how [person authentication](../../../script-catalog/person_authentication/person-authentication.md) | |
| and [consent gathering](../../../script-catalog/consent_gathering/consent-gathering.md) can be | |
| customized using interception scripts. |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
133-133: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
🤖 Prompt for AI Agents
In docs/janssen-server/auth-server/endpoints/authorization.md around lines 130
to 134, the consent gathering link is still pointing to
../../developer/scripts/consent-gathering.md; update that link to
../../../script-catalog/consent_gathering/consent-gathering.md so all three
links use the corrected paths per issue #12243, ensuring the Interception
scripts and person authentication links remain as updated.
| flexibility to configure and customize multiple aspects in Janssen Server. For example, see this documentation to learn | ||
| how [person authentication](../../developer/scripts/person-authentication.md) | ||
| how [person authentication](../../../script-catalog/person_authentication/person-authentication.md) | ||
| and [consent gathering](../../developer/scripts/consent-gathering.md) can be |
There was a problem hiding this comment.
Fix trailing whitespace violation.
Line 133 has trailing spaces detected by markdownlint-cli2 (MD009). Remove the trailing space after "can be".
-and [consent gathering](../../developer/scripts/consent-gathering.md) can be
+and [consent gathering](../../developer/scripts/consent-gathering.md) can be📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| and [consent gathering](../../developer/scripts/consent-gathering.md) can be | |
| and [consent gathering](../../developer/scripts/consent-gathering.md) can be |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
133-133: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
🤖 Prompt for AI Agents
In docs/janssen-server/auth-server/endpoints/authorization.md around line 133,
there is a trailing whitespace after the word "can be" triggering markdownlint
MD009; remove the extra spaces at the end of that line so it ends with "can be"
(no trailing spaces) and commit the change.
| ## Want to contribute? | ||
|
|
||
| If you have content you'd like to contribute to this page in the meantime, you can get started with our [Contribution guide](https://docs.jans.io/head/CONTRIBUTING/). | ||
| If you have content you'd like to contribute to this page in the meantime, you can get started with our [Contribution guide](https://docs.jans.io/head/CONTRIBUTING/). |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
Consider tightening the language on line 138.
The phrase "in the meantime" may be wordy. Consider a more concise alternative such as: "If you have content you'd like to contribute to this page, you can get started with our [Contribution guide]..."
🧰 Tools
🪛 LanguageTool
[style] ~138-~138: ‘in the meantime’ might be wordy. Consider a shorter alternative.
Context: ...t you'd like to contribute to this page in the meantime, you can get started with our [Contribu...
(EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)
🤖 Prompt for AI Agents
In docs/janssen-server/auth-server/endpoints/authorization.md around line 138,
the phrase "in the meantime" is wordy; change the sentence to a tighter wording
such as "If you have content you'd like to contribute to this page, you can get
started with our [Contribution guide](https://docs.jans.io/head/CONTRIBUTING/)."
to remove "in the meantime" and keep the same link and meaning.
2 participants
Fixed two broken links that were throwing 404 errors:
Fixes #12243
Prepare
Description
Target issue
closes #issue-number-here
Implementation Details
Test and Document the changes
Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with
docs:to indicate documentation changes or if the below checklist is not selected.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.