[codex] clean up OAuth 2.0 docs styling, anchors, and OIDC quickstart guidance#104
[codex] clean up OAuth 2.0 docs styling, anchors, and OIDC quickstart guidance#104
Conversation
Deploying qf-api-docs with
|
| Latest commit: |
6f91da8
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3f5a1b57.qf-api-docs.pages.dev |
| Branch Preview URL: | https://codex-remove-oauth-guide-emo.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: 17983e7daa
ℹ️ 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".
|
@codex review |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
Pull request overview
This PR aims to remove decorative emoji styling from the OAuth 2.0 tutorial docs to improve readability/professional tone, while also updating affected anchor links in related OIDC tutorial pages.
Changes:
- Removed emoji prefixes from headings/callouts and adjusted related autogenerated anchors in the OAuth 2.0 tutorial.
- Updated inbound links to the renamed “Why Use…” anchor.
- Updated/rewrote portions of the “public vs confidential client” wording and expanded the “AI handoff” prompt content in the User APIs quickstart.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/tutorials/oidc/getting-started-with-oauth2.mdx | Removes decorative emoji styling across the guide and updates internal anchors/links accordingly. |
| docs/tutorials/oidc/user-apis-quickstart.mdx | Updates wording related to public/confidential clients and revises the AI handoff prompt section. |
| docs/tutorials/oidc/mobile-apps/_intro.mdx | Updates link fragment to match the new “Why Use…” heading anchor in the OAuth2 tutorial. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
basit3407
changed the title
Summary
This PR started as an emoji-styling cleanup for the OAuth 2.0 tutorial and then picked up a small set of related OIDC documentation follow-ups on the same branch.
The result is a documentation polish PR that now covers visual cleanup, anchor stability, and a small amount of wording and AI-handoff refinement in the nearby OIDC quickstart docs.
What changed
docs/tutorials/oidc/getting-started-with-oauth2.mdxdocs/tutorials/oidc/user-apis-quickstart.mdxdocs/tutorials/oidc/mobile-apps/_intro.mdxHow to Link QF Users to Your Datasection so in-page links continue to work after heading cleanuppublic/confidentialterminology instead of exposing internal token-endpoint auth-method labels directly in the main guidanceWhy
The original emoji cleanup improved the tone of the OAuth2 guide, but it also changed some generated fragment IDs and surfaced a few nearby OIDC doc inconsistencies. Keeping these follow-up fixes on the same branch makes the docs internally consistent and prevents broken in-page or cross-page links.
User impact
Validation
NO_UPDATE_NOTIFIER=1 CI=1 yarn buildwas run earlier on this branch after the larger doc changesgit diff --checkHow to Link QF Users to Your Dataanchor and its FAQ link target locallyNotes
This PR does not change OAuth2 or API behavior. It updates documentation presentation, link stability, and reader-facing wording in the affected OIDC docs.