Skip to content

Commit

Permalink
updating docs (#77)
Browse files Browse the repository at this point in the history
  • Loading branch information
TaylorFries authored Apr 30, 2024
2 parents d6a6bc8 + 0dd7e5d commit 4cdfbfb
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 5 deletions.
4 changes: 2 additions & 2 deletions techdocs/docs/getting-started/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ root.render(

!!! note "Note"
SSOProvider has optional props `backendURL`, `idpHint`, `onRefreshExpiry`, and `postLoginRedirectURL`.
See TypeScript Type SSOProviderProps for more details on usage.
See [TypeScript Type](../using-the-package/typescript-types.md) SSOProviderProps for more details on usage.

---

Expand Down Expand Up @@ -60,7 +60,7 @@ Conditionally render a Login or Logout button:

!!! note "Note"
login() has optional props `backendURL`, `idpHint`, and `postLoginRedirectURL`.
See TypeScript Type LoginProps for more details on usage.
See [TypeScript Type](../using-the-package/typescript-types.md) LoginProps for more details on usage.

---

Expand Down
2 changes: 0 additions & 2 deletions techdocs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ This npm package offers an integration solution for connecting React application
They are developed and maintained by the [CITZ IMB Common Code] team, separate from the Common Hosted Single Sign-On ([CSS]) team.
See why we made these packages at [Purpose and Benefits of This Package](purpose-and-benefits.md).

<br />

!!! tip "Tip"
If you don't have an SSO integration check out [SSO Integration Settings].

Expand Down
2 changes: 1 addition & 1 deletion techdocs/docs/purpose-and-benefits.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ We created these packages to integrate with the Common Hosted Single Sign-On ([C
<br />

!!! warning "Important"
These packages complement, rather than replicate, Common Hosted Single Sign-On ([CSS]) or it's [example apps].
These packages complement, rather than replicate, Common Hosted Single Sign-On ([CSS]) and are an alternative to it's [example apps].
They allow our own applications to integrate with the Common Hosted Single Sign-On ([CSS]) Service, providing us access to it's user management capabilities.
They are developed and maintained by the [CITZ IMB Common Code] team, separate from the Common Hosted Single Sign-On ([CSS]) team.

Expand Down

0 comments on commit 4cdfbfb

Please sign in to comment.