197g / 197g/oxide-auth

Improve documentation for third-party frontends

未關閉 適合新手
#14 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
documentation good first issue improvement
主要語言
Rust
星號
783
分支
102
PR 合併指標
30 天內沒有已合併 PR

描述

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`][frontends], most documentation currently lives only under [`code_grant::frontend`][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:
- [x] Additional guides for implementing custom frontends in the main `frontends` module
- [x] ~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.
- [x] ~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

[frontends]: https://docs.rs/oxide-auth/0.2.0/oxide_auth/frontends/index.html
[code_grant_frontend]: https://docs.rs/oxide-auth/0.2.0/oxide_auth/code_grant/frontend/index.html

貢獻指南

開啟貢獻指南

研究方向

閱讀 `frontends` 模組和 `code_grant::frontend` 中的現有文件。檢查 rouille 前端作為一個更簡單的範例。確定在何處添加相關項目之間以及到外部 OAuth 2.0 資源的交叉連結。目標是改進實作自訂前端的指南。

由索引模型根據 Issue 內容生成。

評估

領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
描述清楚
新手友好度
65/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。