Conversation
Deploying qf-api-docs with
|
| Latest commit: |
38ab172
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5a770f70.qf-api-docs.pages.dev |
| Branch Preview URL: | https://codex-content-quickstart-cod.qf-api-docs.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the Content APIs quickstart child guides by adding language-specific implementation examples (notably Python and Node) plus short, page-scoped “AI handoff” prompts, while keeping the main /docs/quickstart/ hub page lean (per the follow-up intent to #107).
Changes:
- Added Python/Node copy-pasteable examples for OAuth2 Client Credentials token retrieval, token caching/401 retry patterns, and the first authenticated
/chapterscall. - Added before/after migration examples for teams moving from
api.quran.comto authenticated Quran Foundation Content APIs. - Added short, task-specific AI handoff prompts to each child page and expanded page keywords for better discovery.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/quickstart/manual-authentication.md | Adds Python requests + Node fetch token request examples and a scoped AI prompt for backend token retrieval. |
| docs/quickstart/token-management.md | Adds Python token cache example (lock + expiry) and a 401 retry-once example, plus a scoped AI prompt. |
| docs/quickstart/first-api-call.md | Adds a Python requests example for the first authenticated /chapters request and a scoped AI prompt. |
| docs/quickstart/migration.md | Adds before/after request examples (old unauthenticated vs new authenticated), a Python migration example, and a scoped AI prompt. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This is a follow-up to #107.
PR #107 correctly split the oversized Content APIs quickstart into a focused hub plus child guides. This follow-up restores more implementation value inside the child guides without bloating the hub again.
What changed
/docs/quickstart/stays short and decision-orientedChild guide improvements
docs/quickstart/manual-authentication.mdrequestsexample for the OAuth2 Client Credentials token requestfetchexample for the same token requestdocs/quickstart/token-management.md401clear-and-retry-once patterndocs/quickstart/first-api-call.mdrequestsexample for the first authenticated/chaptersrequestdocs/quickstart/migration.mdapi.quran.comintegrationWhy
The hub/content split from #107 improved structure, readability, SEO, and GEO, but the child guides were still light on copy-pasteable implementation examples for non-JavaScript readers.
This PR improves practical usability for Python and backend-first developers while keeping the hub page clean. It should also improve generative retrieval because each child page now contains a tighter pairing of explanation plus executable example for a single task.
User impact
Validation
docs/quickstart/Notes
This PR does not change API behavior, auth behavior, SDK behavior, or sidebar structure. It is a documentation follow-up focused on implementation examples and scoped AI handoff prompts.