wasp-lang/wasp

Docs: Provide explicit examples for GitHub UI helpers

Open

#970 ouverte le 24 janv. 2023

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Haskell (4 229 stars) (227 forks)batch import
documentationdxf: authgood first issue

Description

Right now, when talking about auth UI helpers for GitHub, we just refer readers to check out how Google works.

It's not wrong, but it also isn't the best dev experience - it's nicer to see an example of code you can immediately copy/paste. Also, I'm never sure how is "github" spelled, what is capitalized etc.

@shayneczyzewski @vincanger to your attention - lmk if this makes sense or if I missed something.

Live in the docs Screenshot 2023-01-24 at 10 44 55

Guide contributeur

Stack technique
reactnodejs
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic understanding of wasp authFamiliarity with GitHub OAuth
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
Look at the current documentation in web/docs/language/features.md around line 1312, where auth UI helpers for Google are described. Notice the structure and copy paste example provided for Google. Then, create a similar explicit example for GitHub, ensuring proper spelling and capitalization (e.g., 'GitHub'). The example should show the user how to configure GitHub OAuth in their wasp app, matching the style of the existing Google example. Also check the live docs page at wasp lang.dev/docs/language/features#github to see the current state.