nunit / nunit/docs

Idea: track clicks on "Improve this document" links

Open
#591 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area:docfx pri:p3 type:suggestion-or-request
Dominant language
Dockerfile
Stars
600
Forks
158
Avg merge
16h 8m
Merged PRs (30d)
21

Description

An idea I wanted to write up before I lose it.

We have a link on all our articles to improve it. It goes to GitHub where someone can edit the file.

I'd like to track the number of times people click on that link, so that we get a sense of where people might be confused, even if they don't show us that feedback. We should be able to see this by page.

Since we're using google analytics, we should be able to wire up an event to fire when the link is clicked. I'll need to look into how to do it.

Contributor guide

Open the contributing guide

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 locating the shared article template or component that renders the “Improve this document” links, then review the existing Google Analytics setup. Add click tracking that records the page being viewed, and verify that clicks produce distinguishable per-page events in analytics.

Written by the indexing model from the issue text.

Assessment

Domain
analytics, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.