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

Documentation of the count feature is incomplete #6

Open
dmohns opened this issue May 10, 2024 · 0 comments
Open

Documentation of the count feature is incomplete #6

dmohns opened this issue May 10, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@dmohns
Copy link
Member

dmohns commented May 10, 2024

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
@dmohns dmohns added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels May 10, 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 enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant