Repository navigation
docs: Project ID location, identity tokens as the sign-in path, current docs links - #210
Merged
Merged
Conversation
…nt docs links
- README: Project ID under Settings → Project → General, { projectId } form,
identity key path, working Customer identity link (old one 404s), legacy
user hash reduced to an "Older integrations" note with the upgrade guide,
docs.gleap.ai/en/articles links instead of /documentation/ URLs.
- index.d.ts / src JSDoc: initialize names where to find the Project ID;
setUserJwt says when to call it; identify and its userHash describe the
hash as older integrations; clearIdentity says call on logout.
- docs/custom-widget-domains.md: YOUR_PROJECT_ID placeholder.
Comments and docs only; no runtime change, no version bump.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The dashboard link now points to app.gleap.ai (app.gleap.io redirects there), and protected conversation files refer to "Protect new files" under Settings → Security → Conversation files instead of the former "Require authenticated file access" (Project settings → User identity). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What was wrong
docs.gleap.ai/documentation/guides/customer-identity) is a 404.identify(userId, data, userHash)"), labelled the token section "(recommended)", and never linked the upgrade guide.docs.gleap.ai/documentation/...URLs.InitializeOptions.projectIdpointed at "Settings > Project, or the install page";src/Gleap.jsinitializesaid only "formerly SDK key";identifyhad no doc in the typings (and "Indentifies the user session" in src);setUserJwtdid not say when to call it;clearIdentitydid not say "on logout".docs/custom-widget-domains.mdused the placeholderYOUR_PROJECT_SDK_KEY.What changed
Gleap.initialize({ projectId })form; section renamed "Sign in with an identity token", calls out that no separate identify is needed; identity key path; links to Customer identity and the JS user identity page; legacy section replaced by an "Older integrations" note pointing to Upgrade to identity tokens and noting thatidentify(userId, data)alone is an unsigned contact; docs links moved todocs.gleap.ai/en/articles/393|394|395-....InitializeOptions.projectId,initialize,setUserJwt,setUserJwtProvider,clearIdentity, new JSDoc foridentifyand itsuserHashparameter (older integrations, upgrade guide).YOUR_PROJECT_IDplaceholder.Comments and docs only, no runtime change.
npx jestpasses (38 suites, 700 tests).CHANGELOG 19.6.0 is accurate (Project ID rename) and 19.5.2 already lists the provider-restores-after-reload fix, so it is unchanged.
No version bump: the README and package description on npm only update with the next release.
🤖 Generated with Claude Code