docs: add implementation AI prompts to Quick Start#57
Merged
osamasayed merged 9 commits intomainfrom Jan 14, 2026
Merged
Conversation
Collaborator
basit3407
commented
Jan 14, 2026
basit3407
commented
- Add copy/paste AI prompts for Steps 1–4 (config, OAuth2 token, auth client, first call)
- Clarify server-side vs client-side responsibilities (avoid embedding client_secret; proxy recommended)
- Add environment selection notes (prelive vs production) and token reuse guidance
- Improve migration + troubleshooting guidance with AI prompts and acceptance checklists
- Update auto-translate section with translate="no" + notranslate markers
- Add copy/paste AI prompts for Steps 1–4 (config, OAuth2 token, auth client, first call) - Clarify server-side vs client-side responsibilities (avoid embedding client_secret; proxy recommended) - Add environment selection notes (prelive vs production) and token reuse guidance - Improve migration + troubleshooting guidance with AI prompts and acceptance checklists - Update auto-translate section with translate="no" + notranslate markers
Deploying qf-api-docs with
|
| Latest commit: |
6ab36c3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://983f19c2.qf-api-docs.pages.dev |
| Branch Preview URL: | https://docs-quickstart-ai-prompts.qf-api-docs.pages.dev |
- Mark Node/Python token examples as server-side only (not for browser/mobile).
- Update token snippets to read QF_CLIENT_ID/QF_CLIENT_SECRET from env and throw the standard missing-credentials error.
- Add minimal recommended flow examples: backend /chapters proxy route + frontend fetch('/chapters') (no token handling in client).
Contributor
There was a problem hiding this comment.
Pull request overview
This PR significantly enhances the OAuth2 and Quick Start documentation by adding implementation AI prompts for each major integration step. The changes transform the docs from passive reference material into actionable implementation guides.
Changes:
- Added comprehensive User APIs Quick Start guide with platform-specific examples (React Native, Web, iOS, Android)
- Enhanced OAuth2 guide with AI prompts for Steps 1-5 (config, auth URL, token exchange, API calls, refresh)
- Improved Quick Start with token caching patterns, stampede prevention, and complete Python/JavaScript examples
- Updated example URLs from
oauth2-client-exampletooauth2-client-prelivefor consistency - Added OpenID Connect discovery documentation and JWT verification examples
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorials/oidc/user-apis-quickstart.mdx | New Quick Start guide with copy-paste examples for all major platforms |
| docs/tutorials/oidc/getting-started-with-oauth2.mdx | Added AI prompts for each OAuth2 step with implementation checklists |
| docs/quickstart/index.md | Added token caching/lifecycle guidance, SDK promotion, and complete implementation examples |
| docs/tutorials/oidc/openid-connect.mdx | Added OIDC Discovery, JWKS verification, and stable user identifier guidance |
| docs/tutorials/oidc/example-integration.mdx | Restructured with clearer deployment and production guidance |
| docs/tutorials/oidc/mobile-apps/react-native.mdx | Added complete working example with token management |
| openAPI/oauth2-apis/v1.json | Updated redirect_uri examples to use prelive environment |
| docs/oauth2_apis_versioned/*.mdx | Formatting improvements and URL consistency updates |
Comments suppressed due to low confidence (1)
docs/tutorials/oidc/getting-started-with-oauth2.mdx:1
- Excellent terminology clarification in the AI prompt. This distinction prevents developers from incorrectly implementing refresh token logic for Client Credentials flow.
---
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…/qf-api-docs into docs/quickstart-ai-prompts
Addresses review comments: - Generate cryptographically random state using crypto.randomBytes() - Store state in session before redirect - Validate state parameter on callback before exchanging code - Clear state from session after successful validation This prevents CSRF/login attacks where an attacker could trick a victim into using a forged authorization code.
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.