Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation]: improve docs around IdP integration #2641

Open
sabineschaller opened this issue Apr 5, 2024 · 0 comments · May be fixed by #2729
Open

[Documentation]: improve docs around IdP integration #2641

sabineschaller opened this issue Apr 5, 2024 · 0 comments · May be fixed by #2729
Assignees
Labels
type: documentation Improvements or additions to documentation

Comments

@sabineschaller
Copy link
Member

Right now, we only have a short paragraph about the IdP in the Getting Started docs. They also reference some docs in the auth package, but there is no link.

Additionally, we explain the interaction flow here. However, we don't link to it from the Getting Started page.

Finally, it is not clear from the Interaction Flow docs what the id is. Since the route is /grant/:id/:nonce, one may think it's the grantId. However, it is the interactId. This needs to be clarified.

Long story short, we need to completely overhaul our docs on the IdP and how Rafiki interacts with it.

@sabineschaller sabineschaller added the type: documentation Improvements or additions to documentation label Apr 5, 2024
@njlie njlie linked a pull request May 20, 2024 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
Status: Ready for Review
Development

Successfully merging a pull request may close this issue.

2 participants