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

Improve documentation for third-party frontends #14

Open
3 of 5 tasks
HeroicKatora opened this issue Feb 14, 2018 · 0 comments
Open
3 of 5 tasks

Improve documentation for third-party frontends #14

HeroicKatora opened this issue Feb 14, 2018 · 0 comments
Labels
documentation good first issue Help offered or easy while providing an overview improvement Improve existing implementation

Comments

@HeroicKatora
Copy link
Owner

HeroicKatora commented Feb 14, 2018

Project Improvement

It is currently unclear where to start with implementing bindings for other libraries. While the main module for such documentation should be frontends, most documentation currently lives only under code_grant::frontend. Additionally, the 'example' code given by the iron frontend is not extremely friendly as a guide, as it is missing additional reasoning and remarks and includes a bulk of iron specific overhead at the top.

Main features to improve are the following:

  • Additional guides for implementing custom frontends in the main frontends module
  • Add a simpler example 'software' frontend which exemplifies the main structure of any frontend and realizes the guide. A prototype for this is currently implemented for testing purposes under code_grant::tests. The rouille frontend does a good job here.
  • Improve the code style (structure, documentation, exports, maybe even item order) in code_grant::frontend so that the code is more self-documenting and to reduce overhead of implementing bindings. A module frontends::dev exports most types necessary to adapt a custom frontend.
  • Provide better, informational links both between related code items as well as to external resources concerned with OAuth 2.0 in general.

Tracking pull request

  • A pull request does not yet exist
@HeroicKatora HeroicKatora added improvement Improve existing implementation good first issue Help offered or easy while providing an overview documentation labels Feb 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue Help offered or easy while providing an overview improvement Improve existing implementation
Projects
None yet
Development

No branches or pull requests

1 participant