fix/DOCS-5320-ACUL-React-SDK-updates#1038
Merged
Conversation
Rewrites screen doc to match gold standard pattern: adds top description, corrected import paths, fleshed-out methods with descriptions and typed parameters, and cleaned-up Common/Utility Hooks section. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Summary
|
…reens Updated login, login-id, and login-password screen docs so all method descriptions consistently start with "This method " per documentation standards. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… across screen docs Update method descriptions in login-passwordless-email-code, login-passwordless-sms-otp, logout, signup, signup-id, and signup-password screens to consistently start with 'This method' for uniformity with the established screen doc standard. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Insert <Frame> screenshot components into 28 mfa screen pages that were missing them, sourced from the corresponding JS SDK screen documentation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add the missing useChangeLanguage hook to the Common/Utility Hooks section of all 32 mfa-* React SDK screen reference pages. The hook is exported from every mfa-* partial import path in TypeDoc but was not documented in any of the screen docs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…dard Reformatted all 32 mfa-* screen documentation files to align with the established login screen format, including structured Import sections with root/partial import examples, screen description intros, screen-specific import paths, method descriptions with JSX examples, and inline Common/Utility Hook descriptions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… in screen docs - Remove UseErrorOptions, UseErrorsResult, ErrorsResult, and ErrorType ParamField entries from the Common/Utility Hooks section across all 64 screen docs — these belong in the Types reference, not repeated per screen - Fix mfa-begin-enroll-options: remove **Properties** header, fix inline description formatting, and correct malformed MfaEnrollFactorType URL Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…sword screen docs Add 'This hook' prefix to all context and utility hook descriptions, add backtick formatting around screen names, and insert missing screen-level hooks (useSignupId, useSignupPassword) with correct TypeDoc interface links before ## Methods. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
BcnCarlos
changed the title
avanscoy
reviewed
Apr 27, 2026
avanscoy
reviewed
Apr 27, 2026
| <ParamField body='federatedLogin' type={<span>void | Promise<void></span>}> | ||
|
|
||
| Initiates authentication via a federated identity provider such as Google or GitHub. | ||
| This method initiates authentication via a federated identity provider such as Google or GitHub. |
Contributor
There was a problem hiding this comment.
Comma needed to follow convention
avanscoy
reviewed
Apr 27, 2026
avanscoy
reviewed
Apr 27, 2026
| <ParamField body='useOrganization' type={<span>() => <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> | ||
|
|
||
| Provides information about the user's organization if the login is organization-scoped. Returns `null` when no organization context is present. | ||
| This hook provides information about the user's organization if the login is organization-scoped. Returns `null` when no organization context is present. |
Contributor
There was a problem hiding this comment.
Orgs should be capitalized if the reference is to Auth0 Orgs.
avanscoy
reviewed
Apr 27, 2026
| <ParamField body='resendOTP' type={<span>void | Promise<void></span>}> | ||
|
|
||
| Resends the one-time password to the user's phone number. | ||
| This method resends the one-time password to the user's phone number. |
Contributor
There was a problem hiding this comment.
We reference one-time password as (otp) as well as use this param. You should add the acronym here if it's not referenced earlier.
…docs Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
avanscoy
approved these changes
Apr 27, 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
Update ACUL React SDK to match github repo.