Skip to content

docs(cedarling-js): clarify consumer and maintainer guidance - #14662

Closed
Dahkenangnon wants to merge 1 commit into
jans-cedarling-14582from
jans-cedarling-14582-review-docs
Closed

docs(cedarling-js): clarify consumer and maintainer guidance#14662
Dahkenangnon wants to merge 1 commit into
jans-cedarling-14582from
jans-cedarling-14582-review-docs

Conversation

@Dahkenangnon

Copy link
Copy Markdown

Prepare


Description

This is a stacked documentation PR targeting jans-cedarling-14582 (#14635) . It addresses the JavaScript SDK documentation feedback received on #14635 while keeping the published npm README consumer-focused.

It fix review request #14635 (review)

Target issue

Related to #14582
Follow-up to #14635

This child PR should not close the target issue independently; its changes will become part of the parent PR after merging into jans-cedarling-14582.

Implementation Details

The consumer-facing cedarling_js/README.md now:

  • removes the introductory ASCII diagram;
  • corrects the URL policy refresh configuration;
  • clarifies that JWT signature/status validation is enabled by default;
  • explains that jwt.dangerouslyDisableSignatureValidation and logging options are optional JavaScript SDK configuration;
  • documents principal and resource attributes;
  • shows how to access and serialize the complete authorization decision, including diagnostics, reasons, errors, and request ID;
  • uses full GitHub URLs for repository documentation links so they work when the README is rendered on npm.

The maintainer-facing cedarling_js/docs/README.md now:

  • documents how to build the WASM package and JavaScript SDK from source;
  • records the mapping between typed JavaScript options and Cedarling bootstrap properties;
  • explains which native or internal Cedarling properties are intentionally not exposed by the JavaScript SDK;
  • documents the focused unsigned and multi-issuer test commands and their coverage;
  • clarifies that the offline multi-issuer contract fixture does not test remote JWKS signature verification.

There are no runtime, public API, or implementation changes in this PR.


Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed (not applicable — documentation-only change)
  • Relevant unit and integration tests have been added/updated (not applicable — no runtime behavior changed)
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Validation performed:

  • git diff --check passes.
  • The root README link audit found no repository-relative links.
  • Unsigned unit tests passed: 2/2.
  • Unsigned real-WASM contract tests passed: 8/8.
  • Multi-issuer unit tests passed: 4/4.
  • Multi-issuer real-WASM contract tests passed: 7/7.
  • TypeScript build and type checking passed.
  • The cumulative npm run check currently stops at an existing publishable-manifest stderr assertion after 90/91 unit tests; this documentation PR does not modify that test or its implementation.

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. This PR contains documentation changes only and no code changes.

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 4bfda62b-d067-4541-aa3e-f8785a6ff37b

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

@mo-auto

mo-auto commented Jul 29, 2026

Copy link
Copy Markdown
Member

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

Status Scan Engine 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.

@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs comp-jans-cedarling Touching folder /jans-cedarling labels Jul 29, 2026
@ossdhaval ossdhaval added this to the 3.0.0 milestone Jul 30, 2026
@Dahkenangnon
Dahkenangnon requested a review from moabu as a code owner July 30, 2026 14:30
Signed-off-by: Justin Dah-kenangnon <dah.kenangnon@gmail.com>
@Dahkenangnon
Dahkenangnon force-pushed the jans-cedarling-14582-review-docs branch from 8b055de to f14e2be Compare July 30, 2026 14:32
@Dahkenangnon

Copy link
Copy Markdown
Author

Superseded by #14674. The documentation changes have been incorporated and updated alongside the current SDK implementation so the public API and documentation can be reviewed together. Closing this stale documentation-only PR to avoid maintaining two divergent child branches.

@Dahkenangnon
Dahkenangnon deleted the jans-cedarling-14582-review-docs branch July 31, 2026 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs comp-jans-cedarling Touching folder /jans-cedarling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants