umami-software / umami-software/docs

Contribution & placement question: Add "Using pageview tracker configurations in SPAs"

Open
#21 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
5
Forks
24
Avg merge
3d 14h
Merged PRs (30d)
1

Description

Hi, I’d like to contribute a guide for SPA tracking with Umami. The guide will include:

  • Explanation of how trackView() usage differs between traditional websites and SPAs
  • A short React example showing SPA-aware tracking
  • Notes for other SPA frameworks and some suggestions for helper functions
  • A results section summarizing why this approach resolves undercounted views

Could you advise where this content should be added? I was thinking tracker-configuration.md since there’s already a section on using data-auto-track, and this guide could serve as a concrete case where disabling that configuration is helpful. However, that section is brief, so it may be better to place the guide elsewhere and link to data-auto-track for users who want more details.

I’m happy to follow maintainers’ guidance on the preferred location for this content.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading tracker-configuration.md, especially the data-auto-track section, and review how trackView() is documented. Confirm the preferred location with maintainers, then make the guide cover traditional-site versus SPA usage, a short React example, framework notes, helper suggestions, and the results of avoiding undercounted views.

Written by the indexing model from the issue text.

Assessment

Tech stack
react
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.