PLuG user identification docs improvements #279
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 support@ekline.io. |
|
Published docs preview URL: https://devrev-preview-c411e593-c621-4ac6-a7bd-ef1548520397.docs.buildwithfern.com |
There was a problem hiding this comment.
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.
This is too much for a callout. A section would be a more suitable container.
|
Published docs preview URL: https://devrev-preview-61b6cd16-5d18-4682-99c0-8.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-1e8fab86-8b0e-4e8e-8aeb-f.docs.buildwithfern.com |
This reverts commit 5af9512.
|
Published docs preview URL: https://devrev-preview-a9a96576-edff-4c0c-a026-1.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-328b8a33-3dd3-493a-a3cd-1.docs.buildwithfern.com |
|
|
||
| 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. |
|
Published docs preview URL: https://devrev-preview-8e680de8-ce23-4994-9320-c.docs.buildwithfern.com |
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Ben Colborn <ben.colborn@devrev.ai>
|
Published docs preview URL: https://devrev-preview-70b7a74b-9fb3-4a39-8f63-1.docs.buildwithfern.com |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| identity: {}, | ||
| }); | ||
| ``` | ||
| If you're using the PLuG SDK for recording user sessions, calling the `shutdown()` method will stop the ongoing session recording. Re-initializing with the `init()` method will then start a new session recording. To avoid losing continuity, you can pass the details of the ongoing session recording when re-initializing PLuG. |
There was a problem hiding this comment.
Suggestions:
- Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
| If you're using the PLuG SDK for recording user sessions, calling the `shutdown()` method will stop the ongoing session recording. Re-initializing with the `init()` method will then start a new session recording. To avoid losing continuity, you can pass the details of the ongoing session recording when re-initializing PLuG. | |
| If you're using the PLuG SDK for recording user sessions, calling the `shutdown()` method stops the ongoing session recording. Re-initializing with the `init()` method then starts a new session recording. To avoid losing continuity, you can pass the details of the ongoing session recording when re-initializing PLuG. |
|
Published docs preview URL: https://devrev-preview-2e4d43f4-5ae8-4e1a-a941-2.docs.buildwithfern.com |
* PLuG user identification docs improvements * address review comments * diagram font * Revert "diagram font" This reverts commit 5af9512. * diagram font * Update fern/docs/pages/sdks/web/user-identity.mdx Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update fern/docs/pages/sdks/web/user-identity.mdx Co-authored-by: Ben Colborn <ben.colborn@devrev.ai> * update font --------- Co-authored-by: Ben Colborn <ben.colborn@devrev.ai> Co-authored-by: Atul-Butola <atul.butola@devrev.ai> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* Update MCP files description * Remove reference to by field * Update proguard troubleshooting guide (#281) * PLuG user identification docs improvements (#279) * PLuG user identification docs improvements * address review comments * diagram font * Revert "diagram font" This reverts commit 5af9512. * diagram font * Update fern/docs/pages/sdks/web/user-identity.mdx Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update fern/docs/pages/sdks/web/user-identity.mdx Co-authored-by: Ben Colborn <ben.colborn@devrev.ai> * update font --------- Co-authored-by: Ben Colborn <ben.colborn@devrev.ai> Co-authored-by: Atul-Butola <atul.butola@devrev.ai> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * chore: update session ingestion URLs (#282) * Nit * Nit * Update fern/docs/pages/airdrop/mcp.mdx --------- Co-authored-by: Rohan Gupta <rohan.gupta@devrev.ai> Co-authored-by: Kunal Mohta <kunal.mohta@devrev.ai> Co-authored-by: Ben Colborn <ben.colborn@devrev.ai> Co-authored-by: Atul-Butola <atul.butola@devrev.ai> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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