Improve documentation for third-party frontends #14
Labels
documentation
good first issue
Help offered or easy while providing an overview
improvement
Improve existing implementation
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 undercode_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:
frontends
moduleAdd 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 underThe rouille frontend does a good job here.code_grant::tests
.Improve the code style (structure, documentation, exports, maybe even item order) inA modulecode_grant::frontend
so that the code is more self-documenting and to reduce overhead of implementing bindings.frontends::dev
exports most types necessary to adapt a custom frontend.Tracking pull request
The text was updated successfully, but these errors were encountered: