Skip to content

fix(docs): broken links in Janssen Config API documentation#13408

Closed
ShwetaRawat wants to merge 1 commit intoJanssenProject:mainfrom
ShwetaRawat:jans-docs-fix-config-api-links
Closed

fix(docs): broken links in Janssen Config API documentation#13408
ShwetaRawat wants to merge 1 commit intoJanssenProject:mainfrom
ShwetaRawat:jans-docs-fix-config-api-links

Conversation

@ShwetaRawat
Copy link
Copy Markdown

@ShwetaRawat ShwetaRawat commented Mar 4, 2026

Prepare

  • Read PR guidelines
  • Read license information

Description

Target issue

Closes #12234

Implementation Details

Updated broken relative links and image path in the Janssen Config API documentation.

Changes:

  • Corrected path to authorization.md
  • Corrected path to plugins.md
  • Fixed image reference path

Test and Document the changes

  • Relevant documentation has been updated

Summary by CodeRabbit

  • Documentation
    • Updated internal documentation links and asset references to reflect current path structure.

Signed-off-by: Shweta Rawat <shwetarawat524@gmail.com>
@mo-auto
Copy link
Copy Markdown
Member

mo-auto commented Mar 4, 2026

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.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 4, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 41f3bce0-8118-450d-8a5a-9b327f05c0e1

📥 Commits

Reviewing files that changed from the base of the PR and between 27dd703 and 03d6a2d.

📒 Files selected for processing (1)
  • docs/contribute/implementation-design/jans-config-api-design/README.md

📝 Walkthrough

Walkthrough

This pull request fixes broken documentation links and an image reference in the Janssen Config API design documentation by updating relative path depths from two-level (../../) to three-level (../../../) to reflect the correct directory structure.

Changes

Cohort / File(s) Summary
Documentation Path Updates
docs/contribute/implementation-design/jans-config-api-design/README.md
Updated three relative path references: image asset path and two cross-referenced documentation links (authorization and plugins) to correct directory depth for proper resolution.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • ossdhaval
  • manojs1978
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix(docs): broken links in Janssen Config API documentation' clearly summarizes the main change - fixing broken links in documentation.
Description check ✅ Passed The PR description follows the template with target issue reference, implementation details, and required checklist items completed.
Linked Issues check ✅ Passed All three coding requirements from issue #12234 are addressed: authorization.md path corrected, plugins.md path corrected, and image path fixed.
Out of Scope Changes check ✅ Passed All changes are directly related to fixing broken links and image paths in Janssen Config API documentation as specified in issue #12234.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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.

@ossdhaval
Copy link
Copy Markdown
Contributor

Hi,

@ShwetaRawat Apologies for the delayed response.

You PR is blocked because the commit in it does not carry a verified signature.

We will have to close this PR.

We value your contribution and it'll be great if you can contribute towards a different issue. 🤝

@ossdhaval ossdhaval closed this Apr 6, 2026
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 Janssen Config API

3 participants