[codex] Clarify pre-live user API docs#143
Conversation
Deploying qf-api-docs with
|
| Latest commit: |
372d41e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7b576521.qf-api-docs.pages.dev |
| Branch Preview URL: | https://codex-prelive-user-api-docs.qf-api-docs.pages.dev |
![chatgpt-codex-connector[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3e33e91f6d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
…i-docs-guidance # Conflicts: # src/components/UserRelatedApiEnvironmentNotice/paths.js
|
@codex review |
|
Codex Review: Didn't find any major issues. Nice work! ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
There was a problem hiding this comment.
Pull request overview
Improves clarity around the “pre-live” User APIs environment by surfacing a prominent warning in the OAuth/OIDC quickstart and expanding the in-page environment notice, while adjusting the environment switcher fallback behavior and tests accordingly.
Changes:
- Add a high-visibility “Production vs Pre-live” warning section to the User APIs quickstart.
- Expand
UserRelatedApiEnvironmentNoticecopy + styling to explicitly call outprelive.quran.com(auth checks) andprelive.quranreflect.org(Quran Reflect checks). - Update environment-switcher path fallback logic (and tests) to fall back to the environment intro doc instead of the category page; add coverage for category-to-category switching.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/user-related-env-paths.test.cjs | Updates/extends tests for new intro-doc fallback and category mapping behavior. |
| src/components/UserRelatedApiEnvironmentNotice/styles.module.css | Adds layout/typography rules for richer notice body content (paragraphs, lists, links). |
| src/components/UserRelatedApiEnvironmentNotice/paths.js | Switches fallback target to intro docs and refines “needs available doc” checks (excluding category routes). |
| src/components/UserRelatedApiEnvironmentNotice/index.tsx | Expands notice copy for both environments and updates markup to support multi-element body content. |
| docs/tutorials/oidc/user-apis-quickstart.mdx | Adds a pre-live warning section and clarifies “don’t mix environments” guidance. |
| docs/content_apis_versioned/hadiths-by-ayah.api.mdx | Removes trailing whitespace at EOF (generated doc cleanup). |
| docs/content_apis_versioned/hadith-references-by-ayah.api.mdx | Removes trailing whitespace at EOF (generated doc cleanup). |
| docs/content_apis_versioned/hadith-count-within-range.api.mdx | Removes trailing whitespace at EOF (generated doc cleanup). |
| docs/content_apis_versioned/4.0.0/hadiths-by-ayah.api.mdx | Removes trailing whitespace at EOF (generated doc cleanup). |
| docs/content_apis_versioned/4.0.0/hadith-references-by-ayah.api.mdx | Removes trailing whitespace at EOF (generated doc cleanup). |
| docs/content_apis_versioned/4.0.0/hadith-count-within-range.api.mdx | Removes trailing whitespace at EOF (generated doc cleanup). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
Why
Pre-live user APIs run on a separate stack. Developers need a clear, high-visibility reminder about which surfaces to use when validating auth-backed data and Quran Reflect data so they do not mix production and pre-live environments.
Developer impact
Validation
corepack yarn buildyarn gen-all && npx docusaurus buildflowbuild/