Clarify setup prompt loading indicator guidance#1518
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
📝 WalkthroughWalkthroughThis PR updates the generated SDK setup prompt's AI-agent guidance: React Suspense loading boundaries should use a simple loading indicator (spinner/skeleton/"Loading..."), avoid verbose copy like "Getting Hexclave ready...", and use broad loading boundaries sparingly. ChangesLoading Indicator Guidance Update
Sequence Diagram(s)(Skipped — change is a text update and does not introduce multi-component sequential flow beyond prompt propagation.) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Greptile SummaryThis PR updates a single guidance note inside the AI setup prompt, replacing advice to make the loading indicator "visually appealing" with more specific direction: keep it simple, avoid verbose copy like "Getting Stack Auth ready...", and don't scatter loading boundaries across the app unless they cover real async work.
Confidence Score: 5/5Safe to merge — the change is a one-line text update to an AI-only prompt note with no runtime or logic impact. Only a single guidance sentence is updated; no code paths, imports, types, or runtime behaviour are touched. The new wording is consistent with the adjacent example code in the same template. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["getSdkSetupPrompt()"] --> B{mainType?}
B -->|"ai-prompt"| C["isAiPrompt = true"]
B -->|"nextjs / react / ..."| D["isAiPrompt = false"]
C --> E["Include updated loading-indicator note\n(keep it simple, no verbose copy,\nno aggressive loading boundaries)"]
D --> F["Note omitted"]
Reviews (1): Last reviewed commit: "Clarify setup prompt loading indicator g..." | Re-trigger Greptile |
There was a problem hiding this comment.
Pull request overview
Updates AI-facing guidance in the setup prompt to recommend simple loading indicators (spinner/skeleton/"Loading...") and discourages broad/aggressive loading boundaries unless they wrap real async work.
Changes:
- Replaces the prior "make the loading indicator visually appealing" note with concrete guidance to keep it simple and avoid over-using loading boundaries.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@packages/stack-shared/src/ai/unified-prompts/skill-site-prompt-parts/ai-setup-prompt.ts`:
- Line 745: Replace the incorrect brand reference "Stack Auth" with "Hexclave"
in the prompt text (specifically the string containing 'Getting Stack Auth
ready...' in ai-setup-prompt.ts) so the product name is consistent across the
file; locate the prompt/template where the loading copy appears and update the
literal to use "Hexclave" (or change the example to a neutral "Loading..." per
the surrounding guidance) and run a quick search in this module for any other
"Stack Auth" occurrences to update them as well.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 67352da1-7c27-43b9-91a3-931536f9eac6
📒 Files selected for processing (1)
packages/stack-shared/src/ai/unified-prompts/skill-site-prompt-parts/ai-setup-prompt.ts
There was a problem hiding this comment.
1 issue found across 1 file
Reply with feedback, questions, or to request a fix.
Fix all with cubic | Re-trigger cubic
|
Actionable comments posted: 0 |
|
Actionable comments posted: 0 |
Updated the AI setup prompt to recommend simple loading indicators and avoid overusing loading boundaries across the app.
Also regenerated the generated setup prompt docs/snippet to match the source prompt.
Validation:
pnpm run generate-setup-prompt-docspnpm -C /home/ubuntu/repos/stack-auth/packages/stack-shared exec eslint --ext .tsx,.ts src/ai/unified-prompts/skill-site-prompt-parts/ai-setup-prompt.ts --max-warnings=0 --fixpnpm -C /home/ubuntu/repos/stack-auth --filter @stackframe/stack-shared typecheck