Skip to content

docs: clarify word audio vs recitation audio usage#123

Closed
basit3407 wants to merge 3 commits intomainfrom
codex/clarify-word-audio-recitation-docs
Closed

docs: clarify word audio vs recitation audio usage#123
basit3407 wants to merge 3 commits intomainfrom
codex/clarify-word-audio-recitation-docs

Conversation

@basit3407
Copy link
Copy Markdown
Collaborator

Summary

  • clarify the JS SDK docs for browser usage versus backend Content API auth
  • document word.audioUrl as a relative word-by-word asset path resolved against https://audio.qurancdn.com/
  • clarify that recitation audio responses are distinct from word audio in the SDK docs and OpenAPI descriptions

Verification

  • yarn gen-all
  • yarn build
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying qf-api-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8e20678
Status: ✅  Deploy successful!
Preview URL: https://c8d13b62.qf-api-docs.pages.dev
Branch Preview URL: https://codex-clarify-word-audio-rec.qf-api-docs.pages.dev

View logs

@basit3407
Copy link
Copy Markdown
Collaborator Author

Closing as superseded by #147. This PR is stale and conflicts with the current SDK docs rollout; the still-needed word.audioUrl / https://audio.qurancdn.com clarification from issue quran/api-js#47 has been ported into #147.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant