docs: where is the documentation

[bsutton]

The readme states:

🚀 Easy to use: you mainly need to concern yourself with the OidcUserManager class, which is very well documented and has a simple interface.

However I can't find any useful documentation anywhere.

There is an example with little details and the api has no comments on any of the methods and the wiki has no additional details on correct use of this class.

So where should I be looking?

[ahmednfwela]

https://bdaya-dev.github.io/oidc/

it's the purple wiki button at the top

this is for the usage : https://bdaya-dev.github.io/oidc/oidc-usage/

[bsutton]

Thanks for the prompt response. Ah my bad. I was aware of the wiki but was coming back sometime after my initial implementation of the code so was just skimming the site and missed the 'usage link'. I do feel like the package is missing the api docs (no methods appear to be commented) - this is always where I start when working in my IDE. I also feel like the wiki might benefit from some changes. Shorten the home page by moving the install guides into separate pages - one per OS. This would have two benefits - make it easier to find the install guides and make the usage page more obvious. If you are interested in the change I would be happy to submit a pr

…

On Tue, 5 Nov 2024, 1:25 pm Ahmed Fwela, ***@***.***> wrote: https://bdaya-dev.github.io/oidc/ it's the purple wiki button at the top — Reply to this email directly, view it on GitHub <#127 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAG32ODYITVEHUERXMFMCCDZ7AUCXAVCNFSM6AAAAABRFI2JI6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJWGA4TEMBYGM> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[ahmednfwela]

Thanks for the prompt response.

Ah my bad. I was aware of the wiki but was coming back sometime after my
initial implementation of the code so was just skimming the site and missed
the 'usage link'.

I do feel like the package is missing the api docs (no methods appear to be
commented) - this is always where I start when working in my IDE.

I also feel like the wiki might benefit from some changes.

Shorten the home page by moving the install guides into separate pages -
one per OS.

This would have two benefits - make it easier to find the install guides
and make the usage page more obvious.

If you are interested in the change I would be happy to submit a pr

On Tue, 5 Nov 2024, 1:25 pm Ahmed Fwela, @.***> wrote:

https://bdaya-dev.github.io/oidc/

it's the purple wiki button at the top

—
Reply to this email directly, view it on GitHub
#127 (comment),
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AAG32ODYITVEHUERXMFMCCDZ7AUCXAVCNFSM6AAAAABRFI2JI6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJWGA4TEMBYGM
.
You are receiving this because you authored the thread.Message ID:
@.***>

thanks for your valuable feedback, documentation is unfortunately not my strongest suite

I would appreciate it if you make PRs to improve the docs experience 🙏