Conversation
…g copy The roadmap card and the cli/auth roadmap link both said "Auth0"; user-facing surfaces use OAuth as the verb (Auth0 is the provider, not the noun the user touches). Anchor renamed to `#oauth-token-auto-refresh` and the two inbound links in cli/auth.mdx updated to match.
Sweep through the docs prose so user-facing copy says OAuth (the verb the user touches) instead of Auth0 (the underlying provider). Limited to non-literal references; left untouched are: - the literal `mode: "auth0"` value in `~/.arkor/credentials.json` - the `Auth0Credentials` SDK type name and its provenance note - the verbatim `Auth0 did not return a refresh token...` error string emitted by the CLI source Updates: - cli/dev.mdx + JA: "no Auth0 advertised in `/v1/auth/cli/config`" -> "no OAuth advertised in `/v1/auth/cli/config`" - cli/auth.mdx + JA Fix column: "OAuth (Auth0) application" -> "OAuth application"
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates user-facing documentation to consistently describe the sign-in experience in terms of OAuth (what users interact with) rather than Auth0 (the underlying provider), while preserving intentional runtime-contract strings and type names.
Changes:
- Renames the roadmap card and anchor from “Auth0 token auto-refresh” to “OAuth token auto-refresh”, and updates inbound links accordingly (EN/JA).
- Replaces remaining user-facing “Auth0 advertised …” phrasing with “OAuth advertised …” in CLI docs troubleshooting prose (EN/JA).
- Simplifies the “offline_access” remediation copy to refer to the “OAuth application” (EN/JA), while leaving the verbatim CLI error string unchanged.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/roadmap.mdx | Renames OAuth auto-refresh roadmap card + updates anchor id. |
| docs/ja/roadmap.mdx | Japanese mirror of the roadmap card title + anchor id change. |
| docs/cli/dev.mdx | Updates anon-only deployment troubleshooting copy to say “OAuth” instead of “Auth0”. |
| docs/ja/cli/dev.mdx | Japanese mirror of the same troubleshooting copy adjustment. |
| docs/cli/auth.mdx | Updates roadmap anchor link + refines offline_access remediation wording. |
| docs/ja/cli/auth.mdx | Japanese mirror of anchor link update + remediation wording tweak. |
💡 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
Sweep through the docs prose so user-facing copy says OAuth (the verb the
user touches) instead of Auth0 (the underlying provider). Two commits:
docs(roadmap): rename the Auth0 token auto-refresh card to OAuthtoken auto-refresh in
docs/roadmap.mdx+docs/ja/roadmap.mdx. Anchorrenamed to
#oauth-token-auto-refreshand the two inbound links indocs/cli/auth.mdx+docs/ja/cli/auth.mdxupdated to match.docs: replace Auth0 with OAuth incli/dev.mdx+cli/auth.mdxprose (and JA mirrors):
cli/dev.mdx: "no Auth0 advertised in/v1/auth/cli/config" →"no OAuth advertised in …"
cli/auth.mdx: "Enable theoffline_accessscope on the OAuth (Auth0)application" → "OAuth application"
Intentionally not changed
These are runtime-contract values, exported type names, or verbatim strings
the CLI itself emits — substituting "OAuth" would either break behaviour or
desync from the source:
mode: "auth0"value in~/.arkor/credentials.json(andevery doc reference to it).
Auth0CredentialsSDK type name and the parenthetical that explainsit is "named after the underlying Auth0-based provider".
Auth0 did not return a refresh token. Make sure the Application has 'offline_access' scope enabled.error string emitted bypackages/arkor/src/core/auth0.ts.Test plan
pnpm --filter docs build(or Mintlify preview) renders the roadmappage with the renamed card, and the
cli/auth"Token expiry" linklands on the new
#oauth-token-auto-refreshanchor in both locales.git grep -n "Auth0" docs/shows only the intentionally-keptoccurrences listed above.