EnAccess / EnAccess/OpenPAYGO-docs

Documentation of the `count` feature is incomplete

Open
#6 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement good first issue help wanted
Dominant language
JavaScript
Stars
1
Forks
3
PR merge metrics
No merged PRs in 30d

Description

For a new-users the usage of the `count` feature is not easy to understand.

The first time it's mentioned in the documentation start with explaining how to sync the count with a server, here https://enaccess.github.io/OpenPAYGO-docs/docs/openpaygo-token/customization-of-openpaygo-token#counter-synchronisation-feature

and the follow section explains more use-cases of the Token https://enaccess.github.io/OpenPAYGO-docs/docs/openpaygo-token/customization-of-openpaygo-token?_highlight=count#entry-of-unused-older-tokens-unordered

But it's never really explained what the use-case is.

----

A better way of structuring this part of the documentation would be

- Create a new section "Count feature" (probably a more descriptive name should be found)
- Add a new subsection that gives an introduction what the count is
- Group `Counter Synchronisation feature` and `Entry of Unused Older Tokens (Unordered)` as subsection

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.