docsifyjs/docsify

馃挕 Tracking progress

Open

#1,652 opened on Oct 15, 2021

View on GitHub
聽(3 comments)聽(0 reactions)聽(0 assignees)JavaScript聽(26,454 stars)聽(5,630 forks)batch import
help wantedpluginpr welcome

Description

Feature request

It would be useful to add tracking to next buttons to record tracking progress.

What problem does this feature solve?

To know what part the user have already read/studied/learnt

What does the proposed API look like?

ExperienceAPI solves this problem: See here: https://www.ispring.es/blog/xapi-tin-can

How should this be implemented in your opinion?

https://www.adaptlearning.org/index.php/get-started/ Above opensource project solves the issue, but looks too heavy for something just documentation oriented.

Are you willing to work on this yourself?

I don't know enough the lang to be able to help.

Contributor guide

Tech stack
javascript
Domain
frontendanalytics
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Knowledge of docsify plugin systemUnderstanding of xAPI (Experience API)JavaScript programming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate how to add tracking to the next button in docsify. The issue suggests using xAPI (Experience API). Look at the docsify plugin system, specifically how to hook into navigation events. Consider existing plugins that track user progress. The resolved discussion might have insights. No linked PRs.