docs(cedarling-js): clarify consumer and maintainer guidance - #14662
docs(cedarling-js): clarify consumer and maintainer guidance#14662Dahkenangnon wants to merge 1 commit into
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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. Comment |
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Signed-off-by: Justin Dah-kenangnon <dah.kenangnon@gmail.com>
8b055de to
f14e2be
Compare
|
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. |
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.mdnow:jwt.dangerouslyDisableSignatureValidationand logging options are optional JavaScript SDK configuration;The maintainer-facing
cedarling_js/docs/README.mdnow:There are no runtime, public API, or implementation changes in this PR.
Test and Document the changes
Validation performed:
git diff --checkpasses.npm run checkcurrently stops at an existingpublishable-manifeststderr 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.