Update lock-server.md #12747

peddinenisusmitha · 2025-11-24T18:20:01Z

The Lock Server documentation had two broken links in the "See Also" section:

Cedarling Documentation:
- Previous: ../../../docs/cedarling.md
- Updated: ../../../jans-cedarling/README.md
- Reason: The original path returned 404; the correct path points to the Cedarling README in the jans-cedarling repo.
Duplicate 'See Also' heading was removed for clarity.

These changes ensure that all links in the documentation resolve correctly and provide accurate references to Cedarling resources.

Prepare

[ X] Read PR guidelines
[X ] Read license information

Description

This PR fixes broken links in the Lock Server documentation "See Also" section and removes a duplicate heading.

Target issue

closes #issue-number-here
closes #11916

Implementation Details

Previous: ../../../docs/cedarling.md

Updated: ../../../jans-cedarling/README.md

Reason: The previous link returned 404; the new link correctly points to the Cedarling README in the jans-cedarling repository.

Removed duplicate 'See Also' heading for clarity and better readability.

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)

Summary by CodeRabbit

Documentation
- Reformatted Lock Server documentation's reference section for improved readability with updated link structure.
- Updated external documentation paths for Cedarling and Jans CLI references.
- Applied minor formatting enhancements to documentation structure.

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

The Lock Server documentation had two broken links in the "See Also" section: 1. Cedarling Documentation: - Previous: ../../../docs/cedarling.md - Updated: ../../../jans-cedarling/README.md - Reason: The original path returned 404; the correct path points to the Cedarling README in the jans-cedarling repo. 2. Duplicate 'See Also' heading was removed for clarity. These changes ensure that all links in the documentation resolve correctly and provide accurate references to Cedarling resources. Signed-off-by: PEDDINENI VENKATA SUSMITHA <[email protected]>

mo-auto · 2025-11-24T18:20:16Z

✅ 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 · 2025-11-24T18:20:17Z

📝 Walkthrough

Walkthrough

This pull request fixes broken documentation links in the Lock Server documentation. The "See Also" section is reformatted from a bold list to a plain bullet-point list, and external reference paths are updated: the Cedarling Documentation link is corrected to point to the proper jans-cedarling repository location, while the Jans CLI Reference link path remains semantically equivalent with formatting adjustments.

Changes

Cohort / File(s)	Summary
Lock Server Documentation Link Fixes `docs/janssen-server/lock/lock-server.md`	Rewrites the "See Also" section from bold list format to plain bullet-point list; updates Cedarling Documentation path from `../../cedarling/README.md` to `../../../jans-cedarling/README.md`; reformats Jans CLI Reference link entry; adds minor formatting improvements with blank lines

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Single documentation file with purely structural and reference path changes
No code logic or business logic modifications
Changes are straightforward link corrections addressing reported broken references

Suggested labels

kind-bug, area-documentation, comp-docs

Suggested reviewers

ossdhaval
manojs1978

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Update lock-server.md' is too vague and generic; it doesn't specify what was actually updated or why.	Consider a more descriptive title like 'Fix broken links in Lock Server documentation' to better convey the purpose of the changes.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description is mostly complete with clear details about the link fixes and target issues, though the checkbox formatting is inconsistent.
Linked Issues check	✅ Passed	The PR addresses both objectives from issue #11916: updating the Cedarling docs path and fixing the Cedarling README link, though the first path differs slightly from the issue requirement.
Out of Scope Changes check	✅ Passed	All changes are directly related to fixing broken links in the Lock Server documentation as specified in the linked issue; no out-of-scope modifications detected.
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

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:

📝 Description — Summarize the main change in 50–60 words, explaining what was done.

📓 References — List relevant issues, discussions, documentation, or related PRs.

📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.

📊 Contributor Summary — Include a Markdown table showing contributions:
| Contributor | Lines Added | Lines Removed | Files Changed |

✔️ 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.}

coderabbitai

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

📒 Files selected for processing (1)

docs/janssen-server/lock/lock-server.md (1 hunks)

🧰 Additional context used

🧠 Learnings (4)

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

📚 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/lock/lock-server.md

📚 Learning: 2025-11-05T19:45:46.720Z

Learnt from: iromli
Repo: JanssenProject/jans PR: 12623
File: docker-jans-auth-server/Dockerfile:75-78
Timestamp: 2025-11-05T19:45:46.720Z
Learning: The jans-lock-cedarling artifact is available in the Janssen Maven repository at https://jenkins.jans.io/maven/io/jans/jans-lock-cedarling/0.0.0-nightly/ for the nightly version.

Applied to files:

docs/janssen-server/lock/lock-server.md

📚 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/lock/lock-server.md

🪛 markdownlint-cli2 (0.18.1)

docs/janssen-server/lock/lock-server.md

688-688: Multiple headings with the same content

(MD024, no-duplicate-heading)

🔇 Additional comments (1)

docs/janssen-server/lock/lock-server.md (1)

690-694: Verify updated link paths resolve correctly.

The Cedarling Documentation link has been updated to point to ../../../jans-cedarling/README.md. Before merging, ensure these relative paths resolve correctly in the documentation build system.

Based on learnings from prior Janssen Project PRs, relative links in markdown files are validated by the documentation build system rather than local file system checks. Please confirm that:

The new Cedarling link ../../../jans-cedarling/README.md resolves correctly in your local build

The Jans CLI Reference path ../config-guide/config-tools/jans-cli/README.md continues to work as expected

coderabbitai · 2025-11-24T18:21:39Z

docs/janssen-server/lock/lock-server.md

 ## See Also

- **[Janssen Lock Overview](./README.md)**: Complete Lock ecosystem documentation
- **[Cedarling Documentation](../../cedarling/README.md)**: Client-side authorization engine
- **[Cedar Policy Language](https://docs.cedarpolicy.com/)**: Official Cedar documentation
- **[OAuth 2.0 Configuration](../auth-server/oauth-features/README.md)**: OAuth implementation details
- **[Jans CLI Reference](../config-guide/config-tools/jans-cli/README.md)**: Command-line interface documentation
+## See Also
+
+- [Janssen Lock Overview](./README.md): Complete Lock ecosystem documentation
+- [Cedarling Documentation](../../../jans-cedarling/README.md): Client-side authorization engine
+- [Cedar Policy Language](https://docs.cedarpolicy.com/): Official Cedar documentation
+- [OAuth 2.0 Configuration](../auth-server/oauth-features/README.md): OAuth implementation details
+- [Jans CLI Reference](../config-guide/config-tools/jans-cli/README.md): Command-line interface documentation


⚠️ Potential issue | 🔴 Critical

Duplicate "See Also" heading introduces markdown linting violation.

You better think twice! There are two consecutive "## See Also" headings (lines 686 and 688), which violates the MD024 markdown lint rule that static analysis just flagged. Your PR objectives state you're removing a duplicate heading, but the current code shows both headings present.

Remove line 688's duplicate heading to keep the section clean:

## See Also -## See Also - - [Janssen Lock Overview](./README.md): Complete Lock ecosystem documentation - [Cedarling Documentation](../../../jans-cedarling/README.md): Client-side authorization engine - [Cedar Policy Language](https://docs.cedarpolicy.com/): Official Cedar documentation - [OAuth 2.0 Configuration](../auth-server/oauth-features/README.md): OAuth implementation details - [Jans CLI Reference](../config-guide/config-tools/jans-cli/README.md): Command-line interface documentation

The link updates themselves look good (Cedarling docs path corrected to ../../../jans-cedarling/README.md), but this duplicate heading issue needs fixing before merge.

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

Suggested change

## See Also

- **[Janssen Lock Overview](./README.md)**: Complete Lock ecosystem documentation

- **[Cedarling Documentation](../../cedarling/README.md)**: Client-side authorization engine

- **[Cedar Policy Language](https://docs.cedarpolicy.com/)**: Official Cedar documentation

- **[OAuth 2.0 Configuration](../auth-server/oauth-features/README.md)**: OAuth implementation details

- **[Jans CLI Reference](../config-guide/config-tools/jans-cli/README.md)**: Command-line interface documentation

\ No newline at end of file

## See Also

- [Janssen Lock Overview](./README.md): Complete Lock ecosystem documentation

- [Cedarling Documentation](../../../jans-cedarling/README.md): Client-side authorization engine

- [Cedar Policy Language](https://docs.cedarpolicy.com/): Official Cedar documentation

- [OAuth 2.0 Configuration](../auth-server/oauth-features/README.md): OAuth implementation details

- [Jans CLI Reference](../config-guide/config-tools/jans-cli/README.md): Command-line interface documentation

## See Also

- [Janssen Lock Overview](./README.md): Complete Lock ecosystem documentation

- [Cedarling Documentation](../../../jans-cedarling/README.md): Client-side authorization engine

- [Cedar Policy Language](https://docs.cedarpolicy.com/): Official Cedar documentation

- [OAuth 2.0 Configuration](../auth-server/oauth-features/README.md): OAuth implementation details

- [Jans CLI Reference](../config-guide/config-tools/jans-cli/README.md): Command-line interface documentation

🧰 Tools

🪛 markdownlint-cli2 (0.18.1)

688-688: Multiple headings with the same content

(MD024, no-duplicate-heading)

🤖 Prompt for AI Agents

In docs/janssen-server/lock/lock-server.md around lines 686 to 694 there are two consecutive "## See Also" headings causing an MD024 markdown lint violation; remove the duplicate heading on line 688 so only a single "## See Also" remains and keep the following link list unchanged (ensure spacing/line breaks around the remaining heading are correct).

coderabbitai bot requested changes Nov 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update lock-server.md #12747

Update lock-server.md #12747

peddinenisusmitha commented Nov 24, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

mo-auto commented Nov 24, 2025

Uh oh!

coderabbitai bot commented Nov 24, 2025 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Suggested labels

Suggested reviewers

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Nov 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Update lock-server.md #12747

Are you sure you want to change the base?

Update lock-server.md #12747

Conversation

peddinenisusmitha commented Nov 24, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Prepare

Description

Target issue

Implementation Details

Removed duplicate 'See Also' heading for clarity and better readability.

Test and Document the changes

Summary by CodeRabbit

Uh oh!

mo-auto commented Nov 24, 2025

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

Uh oh!

coderabbitai bot commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested labels

Suggested reviewers

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Nov 24, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

peddinenisusmitha commented Nov 24, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 24, 2025 •

edited

Loading