wasp-lang/wasp

Docs: Provide explicit examples for GitHub UI helpers

Open

#970 geöffnet am 24. Jan. 2023

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Haskell (4.229 Stars) (227 Forks)batch import
documentationdxf: authgood first issue

Beschreibung

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

Contributor Guide

Tech Stack
reactnodejs
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic understanding of wasp authFamiliarity with GitHub OAuth
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90
Research-Richtung
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.