Skip to content

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kunal-mohta-99
Copy link
Contributor

@kunal-mohta-99 kunal-mohta-99 commented Jul 15, 2025

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

  • Testing: Negative test cases: null or default values, crash and fault injection tests
  • Testing: Boundary conditions: rolling upgrades, denial-of-service, etc.
  • Testing: Fixing a few existing — flaky or permanently-broken — test cases
  • Observing: Detailed error codes so machines can understand
  • Observing: Adding superior metrics for future debugging
  • Observing: Tracing the hairiest pathways for field serviceability
  • Training: KnowledgeOps update? So AI always works.

Story of the craft

@kunal-mohta-99 kunal-mohta-99 requested a review from a team as a code owner July 15, 2025 17:45
Copy link
Contributor

🌟 EkLine Reviewer

Hello! 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine]

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change
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.

Copy link
Contributor

Copy link
Contributor

@bc-devrev bc-devrev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

identity: {},
});
```
<Callout intent="note">
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants