Skip to content

Integrate SDK documentation and sync fixes-branch updates#26

Merged
osamasayed merged 2 commits intomainfrom
sdk_docs_migration
Oct 22, 2025
Merged

Integrate SDK documentation and sync fixes-branch updates#26
osamasayed merged 2 commits intomainfrom
sdk_docs_migration

Conversation

@basit3407
Copy link
Copy Markdown
Collaborator

  • migrate the SDK documentation into /docs/sdk, adapting frontmatter, navigation, and manual type tables for Docusaurus
  • surface the new SDK section in the global sidebar, navbar, and footer to keep navigation consistent across the portal
  • pull in fixes-branch adjustments to audio, resources, search, migration, and verses guides so the docs match the latest SDK behavior

Testing

  • npm run build
* copy SDK MDX content into new docs/sdk directory with Docusaurus-consistent slugs and formatting
* replace SDK type-table components with static tables and update language examples
* surface SDK section in main sidebar, navbar, and footer navigation
* refresh audio examples to match latest SDK response fields and field-selection guidance
* align resources and search guides with new null-safe logging and info payload conventions
* update migration notice to document removal of quran.v4 namespace in v2
* adjust verses field-selection samples to reflect current translation and word metadata
@basit3407 basit3407 requested a review from osamasayed October 20, 2025 09:04
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying qf-api-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 06b049c
Status: ✅  Deploy successful!
Preview URL: https://fdec2fec.qf-api-docs.pages.dev
Branch Preview URL: https://sdk-docs-migration.qf-api-docs.pages.dev

View logs

@osamasayed osamasayed merged commit 83ac61c into main Oct 22, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants