-
Notifications
You must be signed in to change notification settings - Fork 3
PLuG user identification docs improvements #279
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
base: main
Are you sure you want to change the base?
Conversation
🌟 EkLine ReviewerHello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page. For questions or feedback, please email [email protected]. |
|
||
In most cases, this works as expected—user identification typically happens after login or signup, which causes a page reload and clears any previous PLuG instance. | ||
|
||
However, if your application needs to update the user identity without a full page refresh, you'll need to explicitly delete the existing PLuG instance before initializing it again with the new user information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
However, if your application needs to update the user identity without a full page refresh, you'll need to explicitly delete the existing PLuG instance before initializing it again with the new user information. | |
However, if your application needs to update the user identity without a full page refresh, you need to explicitly delete the existing PLuG instance before initializing it again with the new user information. |
Published docs preview URL: https://devrev-preview-c411e593-c621-4ac6-a7bd-ef1548520397.docs.buildwithfern.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please implement the diagram in Mermaid. https://buildwithfern.com/learn/docs/content/write-markdown#diagrams
identity: {}, | ||
}); | ||
``` | ||
<Callout intent="note"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is too much for a callout. A section would be a more suitable container.
Summary
This change improves the PLuG Web SDK's user identification documentation by adding a visual graphic and a new section for "Changing the user identity" which adds some frequently used code snippets.
Connected Issues
https://app.devrev.ai/devrev/works/ISS-192528
Craftsmanship, Integrity, and Devil’s Advocacy
Story of the craft