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 re-structure #395

Closed
jaroslawkrol opened this issue May 13, 2021 · 7 comments
Closed

Documentation re-structure #395

jaroslawkrol opened this issue May 13, 2021 · 7 comments

Comments

@jaroslawkrol
Copy link

Hi,

There is a pretty fine solution how to detect NFC state changes, in your library. But current documentation in Readme is totally incorrect (probably based on older version ??), what cause devs (like me) have to find the correct way of use in code on their own, what is very annoying.

Please, fix it.
Have a nice development this awesome lib! :)

@whitedogg13
Copy link
Member

@jaroslawkrol ya, thanks for bringing this. You're right and the documentation is indeed NOT clear enough.

I'm still thinking about how to re-structure the documentation for this library. Since the NFC is such a huge topic to understand and lots of corner cases to consider, maybe re-write the whole documentation is required for the long run. However, as a solo developer (almost) with a day job, it's quite hard to keep track of all these.

I will keep this open and rename the title to "better documentation". I think we need a systematic improvement rather than any ad-hoc doc update.

Are you interested in helping us to improve that? :)

@whitedogg13 whitedogg13 changed the title Incompatible documentation about eventListener Documentation re-structure May 15, 2021
@whitedogg13 whitedogg13 pinned this issue May 15, 2021
@chazmcgrill
Copy link

Think jsdoc comments would be really useful on the exposed methods. Especially in files like NfcManager.js.

@limal
Copy link

limal commented Jul 23, 2021

There used to be a list of all exposed functions in the README. I can't find even the most simplistic method like isEnabled() anywhere in the READMEs.

@github-actions
Copy link

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

@github-actions github-actions bot added the Stale label Sep 22, 2021
@github-actions
Copy link

github-actions bot commented Oct 7, 2021

This issue was closed because it has been stalled for 5 days with no activity.

@github-actions github-actions bot closed this as completed Oct 7, 2021
@javix64
Copy link
Collaborator

javix64 commented Mar 6, 2023

hey @whitedogg13 i would like to help in my free time to have a better doc. There is something that i can't understand clearly. Please reach me in twitter if you can, or let me your email :)

@whitedogg13
Copy link
Member

Hi @javix64 , it's awesome to hear that! I'm not active in twitter, so maybe we can discuss via email: [email protected]. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants