fix(docs): organize exports into namespaces for better typedocs #1269
Conversation
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
…pdate error codes
…into SDK-5700-platform-agnostic-error
…k implementations
…cture chore(docs): update typedoc entry points and configuration for better documentation refactor(types): remove unused Auth0Error class
- Updated the Auth0 export to include TimeoutError from the index. - Introduced a new enums.ts file to export SafariViewControllerPresentationStyle and local authentication types. - Modified index.ts to include the new Enums export.
subhankarmaiti
changed the title
…er and update error codes" This reverts commit c7c427c.
…o improve clarity
…and WebWebAuthProvider
… in NativeCredentialsManager and NativeWebAuthProvider
pmathew92
previously approved these changes
Aug 21, 2025
subhankarmaiti
dismissed
pmathew92’s stale review
The base branch was changed.
nandan-bhat
reviewed
Sep 3, 2025
| const currentMajor = semver.major(currentVersion); | ||
| const stableVersions = allVersions.filter((v) => !semver.prerelease(v)); | ||
| const latestStableMajor = stableVersions.find( | ||
| (v) => semver.major(v) < currentMajor |
There was a problem hiding this comment.
What will happen when you cut a -beta release on the latest stable version.
latestStableMajor = 4 and currentVersion = 4.3.5-beta.1`
There was a problem hiding this comment.
In that case, it will only keep the 4.3.5-beta.1 version.
Should we account for this scenario? I was under the assumption that we release beta or alpha versions only for the next major release. Please correct me if that’s not the case, so we can adjust to keep both versions if needed.
nandan-bhat
approved these changes
Sep 3, 2025
gyaneshgouraw-okta
approved these changes
Sep 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR introduces a major overhaul of our documentation generation and publishing process, aimed at improving navigation, clarity, and maintainability.
1. Improved Documentation Structure
The library's exports have been restructured to create a clear, hierarchical structure in the generated TypeDoc documentation. Previously, the docs presented a flat list of all exports, making them difficult to navigate. Now, all public types, classes, and functions are organized into distinct namespaces:
Classes: Contains all exported classes likeAuth0,AuthError, etc.Interface: Contains all TypeScript interfaces and type aliases.Hooks: Contains the React hooks,useAuth0andAuth0Provider.Enums: Contains all enums likeLocalAuthenticationStrategy.This creates a much clearer experience for developers browsing the API documentation.
2. Automated Publishing and Versioning
To support this new structure and streamline our release process, a full CI/CD pipeline for the documentation has been implemented:
publish-docsGitHub Actions workflow now automatically builds and commits the documentation to thegh-pagesbranch after each release.docsdirectory is now treated as a build artifact and has been added to.gitignore.These changes make the documentation significantly easier for developers to use while automating a previously manual part of our release workflow.
Fixes #1267