wasp-lang/wasp

Docs: Provide explicit examples for GitHub UI helpers

Open

Aperta il 24 gen 2023

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Haskell (4229 star) (227 fork)batch import
documentationdxf: authgood first issue

Descrizione

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

Guida contributor

Tech stack
reactnodejs
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Basic understanding of wasp authFamiliarity with GitHub OAuth
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90
Direzione di ricerca
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.