wasp-lang/wasp

Docs: Provide explicit examples for GitHub UI helpers

Open

#970 建立於 2023年1月24日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)Haskell (4,229 star) (227 fork)batch import
documentationdxf: authgood first issue

描述

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

貢獻者指南

技術棧
reactnodejs
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic understanding of wasp authFamiliarity with GitHub OAuth
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
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.