OIDC walkthrough and link-checker fixes#321
Merged
hrischuk-da merged 7 commits intomainfrom May 6, 2026
Merged
Conversation
… RST Closes the OIDC walkthrough gap from the upstream-link gap analysis (.internal/upstream-link-gap-analysis-2026-05-04.md). C-2 (Canton Utility Setup) is intentionally left external — that content is owned by Digital Asset and documented on docs.digitalasset.com; out of scope for docs.canton.network. C-3 needs no action (text mention, not a link). Upstream source: splice:docs/src/community/oidc-config-okta-keycloak.rst (146 lines, hash bb49ca0b). Provider-side step-by-step setup walkthroughs for Okta and Keycloak: client/realm/scope/audience configuration, JWT signing, daml_ledger_api scope mapping. The RST's community-shared disclaimer preserved as a top-level <Warning> block. Ported into a new local page /global-synchronizer/deployment/oidc-providers (verbatim COPIED block). RST :ref:`Configuring Authentication <helm-validator-auth>` resolved to /global-synchronizer/deployment/installation #configuring-authentication; community-discussion external link preserved as a Markdown link. RST -> MDX syntactic conversions only (``X`` -> `X`, :ref:` ... ` -> internal link). Nav: added under Global Synchronizer > Deployment after identity-management (3 version blocks). Link redirect: sdks-tools/sdks/wallet-sdk.mdx line 171 "Community contributions include OIDC configurations for Okta and Keycloak" docs.dev.sync.global/community/oidc-config-okta-keycloak.html -> /global-synchronizer/deployment/oidc-providers Verbatim verification: normalized RST and MDX prose token-compared character-for-character — identical (7855 chars each).
8bitpal
changed the title
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
MDX rejects `<https://...>` autolinks because the parser treats `<` as the start of a JSX tag. The five occurrences in this file blocked `mintlify broken-links` from compiling the page at all. Switching to the `[url](url)` form is the canonical workaround.
The migration from RST to MDX dropped 27 image assets and left their references with relative paths that no longer resolve. This restores the assets under docs-main/images/ in conventional subdirectories and updates each MDX reference to use absolute /images/... paths. Sources for the restored assets are docs-website (canton 3.5, daml 3.5, daml-shell 3.5) and the splice repo. The mintlify broken-links count drops from 492 to 463 — every image-related entry is gone.
…g rename The splice and splice-wallet-kernel repos moved from the hyperledger-labs org to canton-network. The wallet-kernel was also renamed at the same time. Mappings: hyperledger-labs/splice → canton-network/splice hyperledger-labs/splice-wallet-kernel → canton-network/wallet-gateway GitHub redirects from the old paths today, but the redirect is not guaranteed long-term and the old names are confusing for readers. Also updates one related link: CIP-0078 lived in the splice repo's cips/ subdirectory before the migration. CIPs now live in their own repo at canton-foundation/cips, so the app-rewards page now points to canton-foundation/cips/blob/main/cip-0078/cip-0078.md. Snippet files under docs-main/snippets/external/ and docs-main/snippets/generated/ are intentionally not modified — they are mirrored or generated from upstream and need to be fixed at the source. Spot-checked 11 representative new URLs (bare repos, deep file paths, issues, releases, raw content, the CIP move) — all return 200.
8bitpal
changed the title
8bitpal
changed the title
Resolves a content conflict in docs-main/appdev/modules/m7-security.mdx where main extracted the inline open-tracing and authorization sections into dedicated pages at appdev/deep-dives/open-tracing.mdx and appdev/deep-dives/authorization.mdx. Took main's version of m7-security (now a short list of links to the extracted pages). Re-applied the two image-path fixes from this branch to the new locations of the extracted content: jaegerPingSpans.png in open-tracing.mdx and Authentication.svg in authorization.mdx now use absolute /images/appdev/ paths.
PR #287 (API reference dedup) landed on main between merges, deleting docs-main/global-synchronizer/reference/splice-apis.mdx as part of the dedup. This branch had modified that file for the splice org rename (hyperledger-labs -> canton-network). Resolution: accept main's deletion. The dedup target at docs-main/sdks-tools/api-reference/splice-apis.mdx is auto-merged with all 21 splice org renames intact, and PR #287 already added the redirect /global-synchronizer/reference/splice-apis -> /sdks-tools/api-reference/splice-apis to docs.json so the old URL still resolves.
hrischuk-da
previously approved these changes
May 5, 2026
PR #337 (Mintlify CLI validation fixes) on main restored the broken images using the relative-path convention (assets next to the consuming .mdx file) instead of the absolute-path convention this branch had used. Both approaches solved the same problem. Resolution: take main's relative-path approach for all image references, since main now has 27 images placed under docs-main/<page-dir>/images/. Removed the 26 duplicate copies this branch added under docs-main/images/<category>/. Kept docs-main/images/appdev/functional-101-signature.png — main has it at the same absolute path, no duplication. Conflicts touched: open-tracing.mdx, m3-design-patterns.mdx, getting-started-tutorial.mdx, validator-kubernetes.mdx, sv-governance-reference.mdx, splice-apis.mdx, daml-script.mdx, daml-shell.mdx — all resolved to main's ./images/ paths. splice-apis.mdx had two independent changes (main's image-path fix and this branch's hyperledger-labs -> canton-network rename). Took main's version then re-applied the 21 splice org renames. Also updated two auto-merged files (monitoring-setup.mdx, canton-configuration-guide.mdx) whose absolute-path image refs otherwise pointed at the now-deleted docs-main/images/global-synchronizer/ directory.
hrischuk-da
approved these changes
May 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This branch bundles the originally-scoped OIDC walkthrough port with the output of a
mintlify broken-links+lycheeexternal link audit on the same content area.