Skip to content

feat(pre-verified): devrel input#4035

Open
Aaron-Ritter wants to merge 67 commits intoFusionAuth:feature/pre-verified/devrelfrom
sonderformat-llc:feature/pre-verified/devrel-input
Open

feat(pre-verified): devrel input#4035
Aaron-Ritter wants to merge 67 commits intoFusionAuth:feature/pre-verified/devrelfrom
sonderformat-llc:feature/pre-verified/devrel-input

Conversation

@Aaron-Ritter
Copy link
Contributor

This pull request focuses on improving the clarity and consistency of the API documentation, especially around field descriptions, possible values, and terminology. It also adds missing details, corrects minor errors, and enhances guidance for users and developers.

Documentation improvements and clarifications:

  • Added explicit lists of possible values for fields such as user.encryptionScheme, user.twoFactor.methods[x].method, form.steps[x].type, form.type, loginIdType, and verificationStrategy across multiple API documentation files to improve clarity and consistency.
  • Improved and clarified descriptions for fields, such as specifying that FusionAuth stores email addresses in lowercase and that each must be unique, and refining wording for the user.encryptionScheme and oneTimeCode fields.

Content and terminology corrections:

  • Updated terminology to consistently refer to the "FusionAuth admin UI" instead of just "FusionAuth UI" in form-related documentation.
  • Fixed minor typos and improved phrasing for better readability, such as "must have already completed verification" and correcting "the value the with the application Id" in code examples.

Tutorials and guidance enhancements:

  • Added notes and links to relevant tutorials for identity verification workflows, including pre-verification using email and phone, and improved formatting of tutorial lists for better visibility.
  • Clarified the distinction between the Identity Verification API and the Verify Email API, and improved the explanation of when each should be used.

Formatting and consistency:

  • Standardized list formatting (switching from - to *) for tutorial links and possible values in API field descriptions to maintain consistency throughout the documentation.
  • Ensured consistent linking and reference formatting for internal documentation and external resources.

These changes collectively enhance the usability and accuracy of the API documentation, making it easier for developers to understand and implement the APIs correctly.

wied03 and others added 30 commits October 29, 2025 17:09
…cumentation to mail identity pre-verification and finalize content
…fication setup similar to email identity pre-verification
…ocumentation for email and phone identity pre-verification and add a draft to the Troubleshooting section
…I reference section in draft, deprecation notes and improved testing instructions
# Conflicts:
#	astro/src/content/docs/customize/look-and-feel/upgrade.mdx
#	astro/src/content/docs/release-notes/index.mdx
… into feature/pre-verified/devrel-input

# Conflicts:
#	astro/src/content/docs/apis/_user-registration-combined-response-body.mdx
#	astro/src/content/docs/apis/_verificationIds.mdx
#	astro/src/content/docs/apis/custom-forms/_form-request-body.mdx
#	astro/src/content/docs/apis/custom-forms/_form-response-body.mdx
#	astro/src/content/docs/apis/identity-verify.mdx
#	astro/src/content/docs/customize/look-and-feel/upgrade.mdx
#	astro/src/content/docs/lifecycle/manage-users/verification/gate-accounts-until-user-email-verified.mdx
#	astro/src/content/docs/lifecycle/manage-users/verification/gate-accounts-until-user-phone-verified.mdx
#	astro/src/content/docs/lifecycle/register-users/advanced-registration-forms.mdx
#	astro/src/content/docs/operate/secure/advanced-threat-detection.mdx
#	astro/src/content/docs/release-notes/index.mdx
@Aaron-Ritter Aaron-Ritter requested review from a team as code owners December 19, 2025 20:57
@Aaron-Ritter
Copy link
Contributor Author

Copy link
Contributor

@wied03 wied03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, looking good. Just a few points.

Copy link
Contributor

@nathan-contino nathan-contino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor comments.

Copy link
Contributor

@mark-robustelli mark-robustelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reviewed the blog post and made some suggestions. I will let @nathan-contino comment on the rest doc updates.

@Aaron-Ritter
Copy link
Contributor Author

@mark-robustelli @nathan-contino As discussed, I have moved the blog in an own branch so this can be finalized. The review input has been incorporated in the new branch and will be complicated separately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants