Skip to content

Improve Docs: Fix typos, setup clarity, and add OAuth2 FAQ#8

Merged
osamasayed merged 11 commits intoquran:mainfrom
basit3407:main
Jun 4, 2025
Merged

Improve Docs: Fix typos, setup clarity, and add OAuth2 FAQ#8
osamasayed merged 11 commits intoquran:mainfrom
basit3407:main

Conversation

@basit3407
Copy link
Copy Markdown
Collaborator

@basit3407 basit3407 commented Jun 4, 2025 •
edited
Loading

This PR consolidates five documentation improvements to enhance clarity, correctness, and usability of the API docs. It also closes #2 by fixing the typos.

✅ Summary of Changes

  1. Add FAQ page for OAuth2

    • Covers token headers, credentials, and related FAQs.
    • Linked from navbar and tutorials sidebar.

  2. Fix typos in OIDC tutorial

    • Corrects spelling of "briefly" and capitalizes "OpenID" properly in context.

  3. Update README setup instructions

    • Clarifies Node.js version requirement.
    • Documents yarn commands and explains doc generation process.

  4. Fix typo in operationId and regenerate docs

    • Corrects misspelling from recitatoin to recitation.
    • Updates filenames and sidebar references accordingly.

  5. Resolve Issue [#2](Typos "offirst" & "exampke" #2)

    • Applies final typo fix as noted in the issue.
@basit3407 basit3407 requested a review from osamasayed June 4, 2025 03:48
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 4, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
qf-api-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 4, 2025 8:26am
@osamasayed osamasayed merged commit 1bff967 into quran:main Jun 4, 2025
1 check was pending
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants

@basit3407 @osamasayed