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

JavaScript Setup guide: improve writing #79

Open
MauScheff opened this issue Feb 15, 2024 · 2 comments
Open

JavaScript Setup guide: improve writing #79

MauScheff opened this issue Feb 15, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@MauScheff
Copy link

Is your feedback related to a problem? Please describe.
I'm very frustrated because I can't know it I installed it correctly.

Describe the solution you'd like or the information you're missing
Clear documentation that specifies:

  1. where to place the snipped on a svelte codebase.
  2. If it's okay not to pass the client ID (no auth in website), static type checking gives an error here.
  3. How to do the last step which is to verify that everything is connected. I tried sending signals, switching on/off developer mode, and I can't get it to log anything. I also tried adding / removing the crypto package, I'm giving up and going to another analytics platforms because: if it starts like this, I don't want to know how it ends.

Additional context
Add any other context or screenshots about the feature request here.

@MauScheff MauScheff added the documentation Improvements or additions to documentation label Feb 15, 2024
@MauScheff
Copy link
Author

Note: I was using the javascript guide.

@winsmith
Copy link
Contributor

winsmith commented Feb 15, 2024

Hi, thanks for your feedback, I'll try and clarify the article a bit

I havent used svelte myself, so I might not be able to give exact details, but I can make it clearer that

  • the node.js and crypto is not needed in apps like svelte
  • the initialisation should happen once and the TD object be passed around in something like a service or singleton (ember calls these @service)
  • the td.send function should be used to send signals, either automatically in a router-like object or on a per-feature basis

@winsmith winsmith changed the title Feedback for guides/web-setup.md JavaScript Setup guide: improve writing Feb 15, 2024
@winsmith winsmith assigned voidedmain and unassigned voidedmain Feb 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants