jaredhanson / jaredhanson/oauth2orize

Improve wiki and samples

Open
#165 7 comments 5 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
3.5k
Forks
472
PR merge metrics
No merged PRs in 30d

Description

I think this is a great module and I've been using it for a while but I also think is poorly documented.

The first time I tried to use it it was really dificult to wrap my head around it and some of the functions that are used in the api I had to figure out what they were for using trial and error and `console.log`. :-(

I've seen some entries in the wiki and check all those repositories but they suffer the same problem of the examples on this repository, they are all mixed in and where you are trying to learn the api this is a huge barrier of entry.

I think the full api should be documented and maybe a http://oauth2orize.github.io/ site should be published. I think the right strategy for the examples is to write four separate repositories with each of the OAuth flows implemented so people will have a more clear understanding of when some api calls are necesary without having to completely dive in the OAuth2 spec.

I'm also willing to contribute but I will need your help sometimes (so I don't have to `console.log` everything ;-))

Please let me know what you think of this idea

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing wiki entries and repository examples to identify missing API explanations and how the examples are mixed together. Clarify the documentation scope with maintainers before starting; completion would require an agreed full API guide, a published project site if accepted, and clearer examples organized around the OAuth flows.

Written by the indexing model from the issue text.

Assessment

Tech stack
express, javascript, node.js
Domain
backend, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.