Skip to content

fix(docs): fix link of Cedarling Rust Developer Guide #12592

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.

Sign up for GitHub

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

Jump to bottom
Merged
ossdhaval merged 3 commits into from
Nov 6, 2025
Merged

fix(docs): fix link of Cedarling Rust Developer Guide #12592

ossdhaval merged 3 commits into from
Nov 6, 2025
+1 −1

Conversation

@ossdhaval
Copy link
Contributor

@ossdhaval ossdhaval commented Nov 4, 2025 •
edited by coderabbitai bot
Loading

Prepare

Description

Target issue

closes #12495

Implementation Details

Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • 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.

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

Summary by CodeRabbit

  • Documentation
    • Updated reference links in Cedarling Rust documentation for improved navigation accuracy.

@ossdhaval
fix(docs): fix link of Cedarling Rust Developer Guide
f57ec23 
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
@ossdhaval ossdhaval self-assigned this Nov 4, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 4, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

A documentation link in the Cedarling Rust Developer Guide's "See Also" section was updated to fix a broken reference. The relative path was corrected and the anchor target was renamed from #implement-tbac-using-cedarling to #implement-rbac-using-signed-tokens-tbac.

Changes

Cohort / File(s) Summary
Documentation link fix
docs/cedarling/cedarling-rust.md		 Updated broken Cedarling TBAC quickstart link in See Also section: corrected relative path prefix (./) and renamed anchor target to match current documentation structure

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

This is a straightforward documentation link correction with no logic changes or behavioral impact.

Possibly related issues

Possibly related PRs

Suggested labels

comp-jans-cedarling

Suggested reviewers

  • manojs1978
  • nynymike

Pre-merge checks and finishing touches

✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title 'fix(docs): fix link of Cedarling Rust Developer Guide' clearly and concisely describes the main change—fixing a broken documentation link.
Description check ✅ Passed PR description follows the template with target issue #12495 linked, but implementation details section is empty and test/documentation checklists remain unchecked.
Linked Issues check ✅ Passed The PR changes match issue #12495 requirements: broken link is updated from 'cedarling-quick-start.md#implement-tbac-using-cedarling' to './cedarling-quick-start.md#implement-rbac-using-signed-tokens-tbac'.
Out of Scope Changes check ✅ Passed All changes are scoped to fixing the single broken link identified in issue #12495 with no additional unrelated modifications.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-fix-cedarling-rust-developer-guide-link
📜 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 adb84ae and ba1082c.

📒 Files selected for processing (1)
  • docs/cedarling/cedarling-rust.md (1 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.695Z
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/cedarling-rust.md (2)

409-409: Good fix, but where's the local test evidence?

You better think twice! The link change looks correct and matches the PR objectives perfectly—added the ./ prefix and updated the anchor to #implement-rbac-using-signed-tokens-tbac. However, the PR objectives clearly state you must test documentation changes locally per the contribution guide and attach evidence (screenshot or webm). That verification is missing, friend. Based on learnings, local testing is authoritative for link correctness in Jans docs, so please add proof before we ship this.

Can you confirm:

  1. Local testing of the documentation build was performed?
  2. The link resolves correctly to the intended anchor in cedarling-quick-start.md?
  3. Can you provide evidence (e.g., screenshot showing the link working locally)?

410-410: Relative path inconsistency—check line 410.

Line 409 uses ./cedarling-quick-start.md (with ./ prefix), but line 410 on the very next line uses cedarling-quick-start.md (without the prefix). Both link to the same file. Was this inconsistency intentional, or should line 410 also get the ./ prefix for consistency? Drop some clarity here so we're on the same page!

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

@mo-auto
Copy link
Member

mo-auto commented Nov 4, 2025 •
edited
Loading

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

@ossdhaval ossdhaval requested a review from manojs1978 November 4, 2025 09:42
@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs kind-bug Issue or PR is a bug in existing functionality labels Nov 4, 2025
@ossdhaval ossdhaval merged commit 2250afb into main Nov 6, 2025
2 of 3 checks passed
@ossdhaval ossdhaval deleted the docs-fix-cedarling-rust-developer-guide-link branch November 6, 2025 07:19
@coderabbitai coderabbitai bot mentioned this pull request Nov 6, 2025
Merged
6 tasks
@mo-auto mo-auto mentioned this pull request Nov 18, 2025
Merged
This was referenced Nov 18, 2025
Merged
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@manojs1978 manojs1978 manojs1978 approved these changes

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

@ossdhaval ossdhaval

Labels

area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs kind-bug Issue or PR is a bug in existing functionality

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

fix(docs): broken link in the Cedarling Rust Developer Guide

4 participants

@ossdhaval @mo-auto @manojs1978