wasp-lang/wasp

Docs: Provide explicit examples for GitHub UI helpers

Open

#970 opened on Jan 24, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)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

Contributor guide

Tech stack
reactnodejs
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of wasp authFamiliarity with GitHub OAuth
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
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.