Skip to content

docs: add migration guide to quickstart and improve formatting#19

Merged
osamasayed merged 4 commits intomainfrom
migration_guide
Sep 11, 2025
Merged

docs: add migration guide to quickstart and improve formatting#19
osamasayed merged 4 commits intomainfrom
migration_guide

Conversation

@basit3407
Copy link
Copy Markdown
Collaborator

This PR updates the Quickstart documentation with a migration guide for users previously on api.quran.com.

Changes

  • Added a Migration section in Quickstart explaining how to switch from the old unauthenticated API to the new OAuth2-based endpoints.
  • Linked migration step headers to the existing Use the Access Token section to avoid duplication.
  • Fixed anchors for cross-references.
  • Improved admonitions for clarity and consistency.

Why

  • Provide a clear path for existing users to migrate with minimal friction.
  • Ensure documentation anchors and admonitions follow a consistent style.
  • Keep Quickstart friendly for both new and existing developers.
and admonitions

* Add **“Migrating from api.quran.com”** section (under *Important Considerations*) with:

  * OAuth2 steps
  * New base URLs
  * Header guidance
* Normalize headings to **plain ASCII** to stabilize Docusaurus anchor slugs
* Update **internal links** to match correct anchors (`#step-1…`, `#step-2…`, `#step-3…`)
* Convert **garbled blockquotes → proper admonitions** (`tip` / `warning` / `info`)
* Clean **duplicated environment warning line**
* Fix **“Need Help?” contact formatting**
* Minor **copy edits & polish** for clarity and consistency
@vercel
Copy link
Copy Markdown

vercel Bot commented Sep 11, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
qf-api-docs Ready Ready Preview Comment Sep 11, 2025 5:21am
@osamasayed osamasayed merged commit 64765f1 into main Sep 11, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants