Update docs #106
Merged
Update docs #106
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
… consistency - Added a callout for named imports in both Quickstart and SDK sections to enhance user guidance. - Renamed callback functions and sections from "Callback Stub" to "LoginSync Stub" for consistency in terminology. - Updated code examples to reflect the new naming conventions and improve clarity in the integration process. - Revised the logout function to "clearAuth" in the SDK documentation for better alignment with functionality.
- Added a callout for default imports in both Quickstart and SDK sections to improve user guidance. - Updated code examples to use `helloConfig` consistently instead of `config`. - Renamed the callback function in the example from `loggedIn` to `loginSync` for consistency with terminology. - Revised the logout function reference to `clearAuth` in the SDK documentation for better alignment with functionality.
- Updated import statements to consolidate from `@hellocoop/nextjs/react` to `@hellocoop/nextjs` for clarity. - Renamed the callback function from `loggedIn` to `loginSync` in examples to align with updated terminology. - Revised comments and code examples for improved readability and accuracy, including changes to the logout function reference. - Enhanced documentation structure to facilitate better user understanding of the integration process.
- Added new components `<LoggedIn>` and `<LoggedOut>` for managing user authentication states. - Introduced the `useAuth()` hook to retrieve authentication state and user information. - Documented logout functions `logOut()` and `getLogOutRoute()` for improved user guidance. - Updated examples to demonstrate the integration of new components and hooks in a complete application context.
…nts and hooks - Added `<LoggedIn>` and `<LoggedOut>` components for managing user authentication states. - Introduced the `useAuth()` hook to retrieve authentication state and user information. - Documented logout functions `logOut()` and `getLogOutRoute()` for improved user guidance. - Updated examples to demonstrate the integration of new components and hooks in a complete application context.
… and hooks - Added `<LoggedIn>` and `<LoggedOut>` components for managing user authentication states. - Introduced the `useAuth()` hook to retrieve authentication state and user information. - Documented logout functions `logOut()` and `getLogOutRoute()` for improved user guidance. - Updated examples to demonstrate the integration of new components and hooks in a complete application context.
- Added new functions for browser authentication: `createInviteRequest()`, `generateChallenge()`, `verifyChallenge()`, and `pkceChallenge()`. - Introduced server-specific functions: `errorPage()`, `redirectURIBounce()`, `wildcardConsole()`, and `sameSite()`. - Enhanced existing function documentation for clarity and completeness, including detailed return types and usage examples. - Updated code samples to demonstrate the integration of new PKCE functionalities for improved security.
…amples - Added `logoutSync` function to the configuration sample for improved logout handling. - Introduced new optional configuration parameters: `sameSiteStrict`, `cookieToken`, `logConfig`, and `apiRoute` with detailed descriptions. - Updated code examples to reflect changes in parameter names and usage for `loginSync` and `logoutSync`. - Expanded environment variable section to include new options for better customization and flexibility. - Improved overall documentation structure for clarity and user guidance.
…onventions and examples - Added new environment variable names prefixed with `HELLO_` for clarity and consistency. - Expanded descriptions for existing variables and included a complete example of all environment variables. - Improved documentation structure to enhance user understanding of environment variable precedence.
…tation - Expanded cookie options section to include new configurations for `sameSite: 'strict'`, `sameSite: 'none'`, and cross-domain cookie support. - Clarified the conditions under which cookies are set to `secure`. - Updated redirect URI discovery process to reference `HOST` and `HELLO_HOST` environment variables. - Added a new "Common Issues" section addressing common cookie and redirect URI problems for improved user guidance.
…and error responses - Clarified the `auth` operation and introduced `getAuth` as an alias. - Added detailed descriptions for the `invite` operation, including required and optional parameters. - Expanded error response section for various operations to enhance user understanding of potential issues. - Introduced additional operations and protocol flows for comprehensive API coverage.
…and framework template features - Added a section on environment variables, including `HELLO_DOMAIN` for overriding the default domain. - Expanded framework template features to detail automatic file creation and default options for Next.js, Express, and Fastify. - Included examples of generated files for better user guidance and understanding of the setup process.
…mulation details - Added a comprehensive section on the Mock API, detailing available endpoints and their functionalities. - Introduced mock users for testing, including descriptions and email addresses for each user. - Documented supported OpenID Connect scopes and error simulation capabilities, including error codes and status codes. - Provided basic and advanced examples for using the `/mock` API with `curl` commands to enhance user understanding of mock configurations.
…iable sections - Removed extensive sections on environment variables from the configuration and environment documentation for clarity and conciseness. - Updated the "Common Issues" section in the FAQs to streamline information and focus on essential troubleshooting tips. - Enhanced overall documentation structure to improve user navigation and understanding of SDK configuration.
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.
No description provided.