Passport: Improve documentation with complete examples

[AdityaAnand1]

Shouldn't all strategies include complete documentation instead of snippets?

For e.g: http://www.passportjs.org/packages/passport-local/

IMO All strategy docs should contain the following to provide maximum value and quick onboarding to all users:

1. E.g API endpoints: /signup /login /forgot-password
2. Examples for authenticating specific endpoints (blacklisting/whitelisting)
3. Example middleware
4. Complete error handling
5. Token/Session logic
6. Possible combinations of different strategies (e.g Bearer token + local strategy) or rather, recommended patterns.

I realize this would be a major overhaul, but would inevitably make this library far more valuable 😁

[jaredhanson]

Would you volunteer to write this documentation?

Sent from my iPhone

On Jun 1, 2020, at 10:06 PM, Aditya Anand [e-mail] wrote:


Shouldn't all strategies include complete documentation instead of snippets?

For e.g: http://www.passportjs.org/packages/passport-local/

IMO All strategy docs should contain the following to provide maximum value and quick onboarding to all users:

E.g API endpoints: /signup /login /forgot-password
Examples for authenticating specific endpoints (blacklisting/whitelisting)
Example middleware
Complete error handling
Token/Session logic
Possible combinations of different strategies (e.g Bearer token + local strategy) or rather, recommended patterns.
I realize this would be a major overhaul, but would inevitably make this library far more valuable 😁

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub, or unsubscribe.

[AdityaAnand1]

I would, but I've only used passport once for a hobby project in 2014 and just started checking it out again, so probably not the best person.

[jaredhanson]

Ok. I'm going to close this then, as its not a priority and not a functionality issue with this module. The community has published ample tutorials and docs. Always room for improvement, of course. But without an owner, this isn't actionable.

[AdityaAnand1]

Wow.