Skip to content

Conversation

@BurramsettyAkshayaPranathi
Copy link

@BurramsettyAkshayaPranathi BurramsettyAkshayaPranathi commented Nov 24, 2025

Prepare


Description

Target issue

This pull request fixes broken links in the Getting Started with Cedarling Java documentation.

closes #issue-number-here

Closes #12496

Implementation Details

Updated incorrect anchor:
#unsigned-authorization → #custom-principal-authorization-unsigned

Updated TBAC quickstart anchor:
#implement-tbac-using-cedarling → #implement-rbac-using-signed-tokens-tbac

Verified the link changes locally and attached screenshot proof.

Test and Document the changes

  • [X ] Static code analysis has been run locally and issues have been fixed
  • [ X] Relevant unit and integration tests have been added/updated
  • [ X] Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

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.

  • [ X] I confirm that there is no impact on the docs due to the code changes in this PR.

Summary by CodeRabbit

  • Documentation
    • Corrected internal documentation links and navigation anchors in the Java getting started guide.
    • Updated references to authorization configuration and TBAC quickstart sections to align with new documentation structure.

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

@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.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 24, 2025

📝 Walkthrough

Code Review Summary

Walkthrough

This PR fixes broken documentation links in the Java Getting Started guide by updating anchor references. Two navigation targets are corrected: the Unsigned Authorization section anchor and the Cedarling TBAC quickstart reference, ensuring proper documentation navigation.

Changes

Cohort / File(s) Change Summary
Documentation Link Fixes
docs/cedarling/getting-started/java.md
Updated anchor target for Unsigned Authorization from #unsigned-authorization to #custom-principal-authorization-unsigned and corrected TBAC quickstart reference from #implement-tbac-using-cedarling to #implement-rbac-using-signed-tokens-tbac

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Simple anchor and link corrections with no functional code changes
  • Changes are isolated to documentation navigation only
  • Updates align references with renamed sections in the quickstart guide

Possibly related issues

Possibly related PRs

Suggested labels

kind-bug, area-documentation, comp-docs, comp-jans-cedarling

Suggested reviewers

  • manojs1978
  • ossdhaval

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The PR title clearly and concisely describes the main change: fixing broken documentation links in the Cedarling Java getting-started guide.
Description check ✅ Passed The PR description follows the template structure, includes the target issue (#12496), detailed implementation changes with specific anchor corrections, and confirms documentation updates with all required checklist items marked complete.
Linked Issues check ✅ Passed The pull request directly addresses both objectives from issue #12496: correcting the unsigned-authorization anchor and updating the TBAC quickstart reference with the exact proposed fixes specified in the linked issue.
Out of Scope Changes check ✅ Passed All changes in the pull request are scoped to fixing the two broken links identified in issue #12496; no unrelated modifications are present.
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 d6b9f40 and 1e9e0ca.

📒 Files selected for processing (1)
  • docs/cedarling/getting-started/java.md (2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 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.
🔇 Additional comments (2)
docs/cedarling/getting-started/java.md (2)

89-89: LGTM! Anchor correctly maps to section heading.

You better think twice about skipping this one, friend! The updated anchor "#custom-principal-authorization-unsigned" maps perfectly to the section heading at line 167. The old anchor didn't exist in the document, so this fix resolves the broken link. Nice work!


229-229: Anchor target verified—link is valid.

The anchor #implement-rbac-using-signed-tokens-tbac exists in docs/cedarling/cedarling-quick-start.md at line 185 as the heading ## Implement RBAC using signed tokens (TBAC). The external link in your PR is correctly set up and will resolve properly. You're good to roll!

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.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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 Getting Started with Cedarling Java

2 participants