[Docs] Enhance b2c use cases and solution patterns#3024
Merged
Conversation
ThaminduDilshan
added
documentation
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis PR updates B2C customer identity and solution patterns documentation with expanded use-case coverage, restructured architectural guidance, standardized flow terminology across walkthrough pages, and extended roadmap navigation components to align with the documented use-case landscape. ChangesB2C Use-Case Documentation Refresh
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
docs/content/use-cases/b2c/configure-it-yourself.mdxESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox. docs/content/use-cases/b2c/customer-identity.mdxESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox. docs/content/use-cases/b2c/identity-concepts.mdxESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox.
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/content/use-cases/b2c/customer-identity.mdx`:
- Line 118: Replace the unhyphenated compound modifier "consumer self sign-up"
with the hyphenated form "consumer self-sign-up" in the sentence that begins
"Behind every consumer product..." so the phrase reads "consumer self-sign-up"
for grammatical consistency; update that occurrence and any other identical
instances in the same document to use the hyphenated compound modifier.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: a839bceb-ed27-47d4-a8c3-78c85f6e4da6
📒 Files selected for processing (10)
docs/content/use-cases/b2c/configure-it-yourself.mdxdocs/content/use-cases/b2c/customer-identity.mdxdocs/content/use-cases/b2c/identity-concepts.mdxdocs/content/use-cases/b2c/solution-patterns.mdxdocs/content/use-cases/b2c/try-it-out/account-recovery.mdxdocs/content/use-cases/b2c/try-it-out/add-login.mdxdocs/content/use-cases/b2c/try-it-out/onboard-internal-users.mdxdocs/content/use-cases/b2c/try-it-out/profile-section.mdxdocs/content/use-cases/b2c/try-it-out/self-sign-up.mdxdocs/src/components/B2CIdentityJourney.tsx
ThaminduDilshan
force-pushed
the
thamindu-docs
branch
from
ef02721 to
3c86a1a
Compare
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/src/components/B2CIdentityJourney.tsx (1)
186-198:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAlign integration approach labels with documented naming convention.
Line 186 and Line 197 use
Redirect-Based/App-Native, but the docs convention usesRedirect-based/App-nativefor consistency across pages and roadmaps.Suggested fix
{ href: '`#redirect-based`', - label: 'Redirect-Based', + label: 'Redirect-based', icon: ( <svg viewBox="0 0 24 24"> @@ { href: '`#app-native`', - label: 'App-Native', + label: 'App-native', icon: ( <svg viewBox="0 0 24 24">As per coding guidelines, keep the three approach names consistent across docs: “Redirect-based”, “App-native”, and “Direct API”.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/src/components/B2CIdentityJourney.tsx` around lines 186 - 198, Update the approach labels to match docs convention by changing the label values used in the B2CIdentityJourney component: replace "Redirect-Based" with "Redirect-based" and "App-Native" with "App-native" (and verify the third approach is "Direct API" elsewhere if present) so the label strings in the icon/label objects align with the documented naming convention.
🧹 Nitpick comments (1)
docs/src/components/B2CIdentityJourney.tsx (1)
220-263: ⚡ Quick winExtract shared roadmap nav rendering to avoid triplicated JSX.
B2CIdentityJourneyRoadmap,B2CSolutionPatternsRoadmap, andB2CIntegrationApproachesRoadmapall duplicate the same render structure. A tiny shared renderer improves maintainability and reduces drift risk.Suggested refactor
+function B2CRoadmapNav({ nodes, ariaLabel }: { nodes: RoadmapNode[]; ariaLabel: string }) { + return ( + <nav className="uc-b2c-roadmap" aria-label={ariaLabel}> + {nodes.map((node) => ( + <a key={node.href} href={node.href} className="uc-b2c-roadmap__node"> + <span className="uc-b2c-roadmap__icon" aria-hidden> + {node.icon} + </span> + <span className="uc-b2c-roadmap__label">{node.label}</span> + </a> + ))} + </nav> + ); +} + export function B2CIdentityJourneyRoadmap() { - return ( - <nav className="uc-b2c-roadmap" aria-label="B2C identity use case roadmap"> - {roadmapNodes.map((node) => ( - <a key={node.href} href={node.href} className="uc-b2c-roadmap__node"> - <span className="uc-b2c-roadmap__icon" aria-hidden> - {node.icon} - </span> - <span className="uc-b2c-roadmap__label">{node.label}</span> - </a> - ))} - </nav> - ); + return <B2CRoadmapNav nodes={roadmapNodes} ariaLabel="B2C identity use case roadmap" />; } @@ export function B2CSolutionPatternsRoadmap() { - return ( - <nav className="uc-b2c-roadmap" aria-label="B2C solution pattern roadmap"> - {solutionPatternNodes.map((node) => ( - <a key={node.href} href={node.href} className="uc-b2c-roadmap__node"> - <span className="uc-b2c-roadmap__icon" aria-hidden> - {node.icon} - </span> - <span className="uc-b2c-roadmap__label">{node.label}</span> - </a> - ))} - </nav> - ); + return <B2CRoadmapNav nodes={solutionPatternNodes} ariaLabel="B2C solution pattern roadmap" />; } @@ export function B2CIntegrationApproachesRoadmap() { - return ( - <nav className="uc-b2c-roadmap" aria-label="B2C integration approaches roadmap"> - {integrationApproachNodes.map((node) => ( - <a key={node.href} href={node.href} className="uc-b2c-roadmap__node"> - <span className="uc-b2c-roadmap__icon" aria-hidden> - {node.icon} - </span> - <span className="uc-b2c-roadmap__label">{node.label}</span> - </a> - ))} - </nav> - ); + return <B2CRoadmapNav nodes={integrationApproachNodes} ariaLabel="B2C integration approaches roadmap" />; }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/src/components/B2CIdentityJourney.tsx` around lines 220 - 263, Create a single reusable Roadmap component and have B2CIdentityJourneyRoadmap, B2CSolutionPatternsRoadmap, and B2CIntegrationApproachesRoadmap delegate to it: implement a Roadmap({nodes, ariaLabel}) renderer that returns the shared <nav className="uc-b2c-roadmap" aria-label={ariaLabel}> and maps nodes to anchors using node.href as key and rendering node.icon and node.label inside the existing span structure, then update B2CIdentityJourneyRoadmap to call <Roadmap nodes={roadmapNodes} ariaLabel="B2C identity use case roadmap" />, B2CSolutionPatternsRoadmap to call <Roadmap nodes={solutionPatternNodes} ariaLabel="B2C solution pattern roadmap" />, and B2CIntegrationApproachesRoadmap to call <Roadmap nodes={integrationApproachNodes} ariaLabel="B2C integration approaches roadmap" /> so the classNames, keys, and inner markup remain identical.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/src/components/B2CIdentityJourney.tsx`:
- Around line 186-198: Update the approach labels to match docs convention by
changing the label values used in the B2CIdentityJourney component: replace
"Redirect-Based" with "Redirect-based" and "App-Native" with "App-native" (and
verify the third approach is "Direct API" elsewhere if present) so the label
strings in the icon/label objects align with the documented naming convention.
---
Nitpick comments:
In `@docs/src/components/B2CIdentityJourney.tsx`:
- Around line 220-263: Create a single reusable Roadmap component and have
B2CIdentityJourneyRoadmap, B2CSolutionPatternsRoadmap, and
B2CIntegrationApproachesRoadmap delegate to it: implement a Roadmap({nodes,
ariaLabel}) renderer that returns the shared <nav className="uc-b2c-roadmap"
aria-label={ariaLabel}> and maps nodes to anchors using node.href as key and
rendering node.icon and node.label inside the existing span structure, then
update B2CIdentityJourneyRoadmap to call <Roadmap nodes={roadmapNodes}
ariaLabel="B2C identity use case roadmap" />, B2CSolutionPatternsRoadmap to call
<Roadmap nodes={solutionPatternNodes} ariaLabel="B2C solution pattern roadmap"
/>, and B2CIntegrationApproachesRoadmap to call <Roadmap
nodes={integrationApproachNodes} ariaLabel="B2C integration approaches roadmap"
/> so the classNames, keys, and inner markup remain identical.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: ccea7091-331f-4b92-be0c-98c5ba8d4597
📒 Files selected for processing (11)
.vale/styles/config/vocabularies/vocab/accept.txtdocs/content/use-cases/b2c/configure-it-yourself.mdxdocs/content/use-cases/b2c/customer-identity.mdxdocs/content/use-cases/b2c/identity-concepts.mdxdocs/content/use-cases/b2c/solution-patterns.mdxdocs/content/use-cases/b2c/try-it-out/account-recovery.mdxdocs/content/use-cases/b2c/try-it-out/add-login.mdxdocs/content/use-cases/b2c/try-it-out/onboard-internal-users.mdxdocs/content/use-cases/b2c/try-it-out/profile-section.mdxdocs/content/use-cases/b2c/try-it-out/self-sign-up.mdxdocs/src/components/B2CIdentityJourney.tsx
✅ Files skipped from review due to trivial changes (8)
- docs/content/use-cases/b2c/try-it-out/onboard-internal-users.mdx
- .vale/styles/config/vocabularies/vocab/accept.txt
- docs/content/use-cases/b2c/identity-concepts.mdx
- docs/content/use-cases/b2c/try-it-out/add-login.mdx
- docs/content/use-cases/b2c/configure-it-yourself.mdx
- docs/content/use-cases/b2c/try-it-out/self-sign-up.mdx
- docs/content/use-cases/b2c/try-it-out/profile-section.mdx
- docs/content/use-cases/b2c/try-it-out/account-recovery.mdx
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Malith-19
reviewed
May 27, 2026
ThaminduDilshan
force-pushed
the
thamindu-docs
branch
from
3c86a1a to
b0c2cec
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/content/use-cases/b2c/customer-identity.mdx`:
- Around line 137-190: The introductory cross-cutting paragraph still says “five
core use cases” but three new primary use-case sections were added; update that
phrasing to the correct count (“eight core use cases”) or change to a
non-numeric phrase (e.g., “several core use cases”) in the page intro (the
cross-cutting intro that currently contains “five core use cases”) so the intro
matches the new sections and maintains existing doc style and tone.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 77405ac7-19e0-4e91-b35f-121a12d62894
📒 Files selected for processing (11)
.vale/styles/config/vocabularies/vocab/accept.txtdocs/content/use-cases/b2c/configure-it-yourself.mdxdocs/content/use-cases/b2c/customer-identity.mdxdocs/content/use-cases/b2c/identity-concepts.mdxdocs/content/use-cases/b2c/solution-patterns.mdxdocs/content/use-cases/b2c/try-it-out/account-recovery.mdxdocs/content/use-cases/b2c/try-it-out/add-login.mdxdocs/content/use-cases/b2c/try-it-out/onboard-internal-users.mdxdocs/content/use-cases/b2c/try-it-out/profile-section.mdxdocs/content/use-cases/b2c/try-it-out/self-sign-up.mdxdocs/src/components/B2CIdentityJourney.tsx
✅ Files skipped from review due to trivial changes (6)
- docs/content/use-cases/b2c/identity-concepts.mdx
- docs/content/use-cases/b2c/configure-it-yourself.mdx
- .vale/styles/config/vocabularies/vocab/accept.txt
- docs/content/use-cases/b2c/try-it-out/account-recovery.mdx
- docs/content/use-cases/b2c/try-it-out/self-sign-up.mdx
- docs/content/use-cases/b2c/try-it-out/profile-section.mdx
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/content/use-cases/b2c/try-it-out/onboard-internal-users.mdx
- docs/content/use-cases/b2c/try-it-out/add-login.mdx
- docs/src/components/B2CIdentityJourney.tsx
- docs/content/use-cases/b2c/solution-patterns.mdx
ThaminduDilshan
force-pushed
the
thamindu-docs
branch
from
b0c2cec to
1e2b2da
Compare
thiva-k
approved these changes
May 27, 2026
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/content/use-cases/b2c/customer-identity.mdx`:
- Line 141: Update the paragraph that begins "A clean closure flow gives the
user a self-service path..." to separate suspension/deactivation outcomes from
deletion/expiration outcomes: state that suspension/deactivation (including
admin-initiated suspension) blocks sign-in and records a reason but does not
immediately remove user data, while deletion/expiration flows remove account
data in accordance with the configured retention policy and prior notice; ensure
the wording references the existing phrases "self-service path",
"admin-initiated suspension", and "retention policy" so reviewers can find and
replace the original combined sentence with two clear outcome statements.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: e0048fbd-5bfa-4674-bdbe-ee2480008640
📒 Files selected for processing (11)
.vale/styles/config/vocabularies/vocab/accept.txtdocs/content/use-cases/b2c/configure-it-yourself.mdxdocs/content/use-cases/b2c/customer-identity.mdxdocs/content/use-cases/b2c/identity-concepts.mdxdocs/content/use-cases/b2c/solution-patterns.mdxdocs/content/use-cases/b2c/try-it-out/account-recovery.mdxdocs/content/use-cases/b2c/try-it-out/add-login.mdxdocs/content/use-cases/b2c/try-it-out/onboard-internal-users.mdxdocs/content/use-cases/b2c/try-it-out/profile-section.mdxdocs/content/use-cases/b2c/try-it-out/self-sign-up.mdxdocs/src/components/B2CIdentityJourney.tsx
✅ Files skipped from review due to trivial changes (5)
- docs/content/use-cases/b2c/try-it-out/onboard-internal-users.mdx
- .vale/styles/config/vocabularies/vocab/accept.txt
- docs/content/use-cases/b2c/try-it-out/account-recovery.mdx
- docs/content/use-cases/b2c/try-it-out/add-login.mdx
- docs/content/use-cases/b2c/try-it-out/self-sign-up.mdx
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/content/use-cases/b2c/configure-it-yourself.mdx
- docs/content/use-cases/b2c/identity-concepts.mdx
- docs/content/use-cases/b2c/solution-patterns.mdx
- docs/src/components/B2CIdentityJourney.tsx
ThaminduDilshan
force-pushed
the
thamindu-docs
branch
from
1e2b2da to
98042b7
Compare
Contributor
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/content/use-cases/b2c/customer-identity.mdx (1)
193-193:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUpdate the use-case count to match the new structure.
Line 193 still references "five core use cases," but the document now includes eight primary use-case sections (the original five plus three new sections added in this PR). Either update to "eight core use cases" or use a non-numeric phrasing like "Beyond the core use cases" to avoid future maintenance.
Suggested fix
-Beyond the five core use cases, a few capabilities span them all. They are not separate journeys but choices and behaviors that shape sign-in, self sign-up, profile management, recovery, and invitation flows in similar ways. Treat them as decisions you make once and apply consistently. +Beyond the core use cases, a few capabilities span them all. They are not separate journeys but choices and behaviors that shape sign-in, self sign-up, profile management, recovery, and invitation flows in similar ways. Treat them as decisions you make once and apply consistently.As per coding guidelines: "Review documentation changes for: Technical accuracy ... Consistency: does the style match existing documentation?"
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/content/use-cases/b2c/customer-identity.mdx` at line 193, Update the sentence that reads "Beyond the five core use cases, ..." to reflect the new structure by replacing "five core use cases" with "eight core use cases" or use a non-numeric phrase such as "Beyond the core use cases"; locate the exact sentence in the customer identity document (the paragraph starting "Beyond the five core use cases, a few capabilities span them all.") and make the replacement so the count matches the added sections.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@docs/content/use-cases/b2c/customer-identity.mdx`:
- Line 193: Update the sentence that reads "Beyond the five core use cases, ..."
to reflect the new structure by replacing "five core use cases" with "eight core
use cases" or use a non-numeric phrase such as "Beyond the core use cases";
locate the exact sentence in the customer identity document (the paragraph
starting "Beyond the five core use cases, a few capabilities span them all.")
and make the replacement so the count matches the added sections.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: fcf47c85-1931-4228-a1df-dbb312c4fcd4
📒 Files selected for processing (11)
.vale/styles/config/vocabularies/vocab/accept.txtdocs/content/use-cases/b2c/configure-it-yourself.mdxdocs/content/use-cases/b2c/customer-identity.mdxdocs/content/use-cases/b2c/identity-concepts.mdxdocs/content/use-cases/b2c/solution-patterns.mdxdocs/content/use-cases/b2c/try-it-out/account-recovery.mdxdocs/content/use-cases/b2c/try-it-out/add-login.mdxdocs/content/use-cases/b2c/try-it-out/onboard-internal-users.mdxdocs/content/use-cases/b2c/try-it-out/profile-section.mdxdocs/content/use-cases/b2c/try-it-out/self-sign-up.mdxdocs/src/components/B2CIdentityJourney.tsx
✅ Files skipped from review due to trivial changes (5)
- docs/content/use-cases/b2c/configure-it-yourself.mdx
- docs/content/use-cases/b2c/try-it-out/add-login.mdx
- docs/content/use-cases/b2c/try-it-out/onboard-internal-users.mdx
- docs/content/use-cases/b2c/try-it-out/account-recovery.mdx
- docs/content/use-cases/b2c/solution-patterns.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/content/use-cases/b2c/identity-concepts.mdx
- docs/src/components/B2CIdentityJourney.tsx
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
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
3 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.
Purpose
This pull request makes improvements to the B2C use cases documentation adding new use cases/ solution patterns and restructuring to improve clarity, organization, and coverage of solution patterns.
Approach
Related Issues
Related PRs
Checklist
breaking changelabel added.Security checks
Summary by CodeRabbit
Documentation
Style