feat(docs): 📚 improve documentation clarity and tool descriptions#694
feat(docs): 📚 improve documentation clarity and tool descriptions#694
Conversation
- Add star prompt to README/README-EN for release notifications - Reorganize mcp-tools.md from table to grouped list - Update tool descriptions in scripts/tools.json to distinguish server-side vs client-side usage - Add SDK vs MCP tools distinction in prompt docs - Add domain management tools clarification in cloudbase-platform.mdx - Add role management documentation in cloudbase-platform.mdx - Fix phone auth example in auth-web.mdx (signUp instead of signInWithOtp) - Remove outdated video tutorial from TutorialsGrid.tsx - Update doc/index.mdx tips
![chatgpt-codex-connector[bot]](https://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: fdb5daa9a1
ℹ️ 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".
| - For phone registration, send the phone number to `auth.signUp({ phone, ... })` first, then call the returned `verifyOtp({ token })`. Do not swap the order. | ||
| ```js | ||
| const { data, error } = await auth.signInWithOtp({ phone: '13800138000' }) | ||
| const { data, error } = await auth.signUp({ phone: '13800138000' }) | ||
| const { data: loginData, error: loginError } = await data.verifyOtp({ token:'123456' }) |
There was a problem hiding this comment.
In the Login Methods section, the phone OTP flow now uses auth.signUp({ phone }) as the primary example, which is a registration path and will fail for users who already have an account; this makes the documented login path incorrect for a common production scenario. This also conflicts with the repo’s own SDK hint mapping (mcp/src/tools/app-auth.ts) where phone OTP login is auth.signInWithOtp({ phone }), so readers following this section can implement a non-working login flow for existing users.
Useful? React with 👍 / 👎.
signUp is registration-only and fails for existing users. signInWithOtp with shouldCreateUser (default true) correctly handles both new and existing users.
- Fix source SKILL.md: restore signInWithOtp for phone OTP login (signUp is registration-only, fails for existing users) - Regenerate doc/prompts/auth-web.mdx from corrected source
1 participant
Summary
Changes
README.md/README-EN.md: added friendly star reminder for release notificationsdoc/mcp-tools.md: restructured from flat table to grouped tool listscripts/tools.json: improved tool descriptions with server/client distinctiondoc/prompts/*.mdx: added clarification sections for domain tools, SDK vs MCP, and role managementdoc/components/TutorialsGrid.tsx: removed outdated video entry{and{})Checklist