197g / 197g/oxide-auth

Improve example documentation

Ouverte Adaptée aux débutants
#117 4 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation improvement
Langage dominant
Rust
Étoiles
783
Forks
102
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

# Project Improvement

The lack of comments and the complexity in the setup leads to bad understanding of the examples, especially without prior knowledge of OAuth2's inner workings. In particular:

- It's unclear which portions of the examples belong to the server and must be provided.
- Which are purely for the sake of the example client. This being an increased concern for `rocket` where we _must_ use the same server as the library only allows 'launching one Rocket'.
- The example structures differ quite a bit. (See also #111)

## Comment

Original report (through another channel) also says this:

> what was unclear in the examples what are the required parts of example for the server side of the authentication in particular the Client Fairing impl and whats just for the client side in the two files names rocket.rs, something that would be helpful would just adding comments where they are missing in the those two files

# Tracking pull request

- [ ] A pull request does not yet exist

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Look at the example files, likely in an examples/ directory, focusing on rocket.rs and any other server/client examples. Identify which parts are server-side (like Client Fairing impl) and which are client-side. Add clarifying comments to separate these responsibilities and explain the setup, especially for the rocket example where only one server can be launched.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
rust
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
65/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.