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
…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
pmathew92
approved these changes
Aug 21, 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 restructures the library's exports to significantly improve the generated TypeDoc documentation.
Currently, the documentation presents a flat list of all exports, making it difficult for developers to navigate. To address this, we've organized all public types, classes, and functions 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 clear, hierarchical structure in the generated documentation, enhancing readability and ease of use. The
typedoc.jsonconfiguration has been updated to reflect these new entry points.Fixes #1267