Skip to content

Clarify setup prompt loading indicator guidance#1518

Open
Developing-Gamer wants to merge 3 commits into
devfrom
devin/1780001115-simple-loading-prompt
Open

Clarify setup prompt loading indicator guidance#1518
Developing-Gamer wants to merge 3 commits into
devfrom
devin/1780001115-simple-loading-prompt

Conversation

@Developing-Gamer
Copy link
Copy Markdown
Collaborator

@Developing-Gamer Developing-Gamer commented May 28, 2026

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-docs
  • pnpm -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 --fix
  • pnpm -C /home/ubuntu/repos/stack-auth --filter @stackframe/stack-shared typecheck

Copilot AI review requested due to automatic review settings May 28, 2026 20:45
@vercel
Copy link
Copy Markdown

vercel Bot commented May 28, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
stack-auth-hosted-components Ready Ready Preview, Comment May 28, 2026 9:19pm
stack-auth-internal-tool Ready Ready Preview, Comment May 28, 2026 9:19pm
stack-auth-mcp Ready Ready Preview, Comment May 28, 2026 9:19pm
stack-auth-skills Ready Ready Preview, Comment May 28, 2026 9:19pm
stack-backend Ready Ready Preview, Comment May 28, 2026 9:19pm
stack-dashboard Ready Ready Preview, Comment May 28, 2026 9:19pm
stack-demo Ready Ready Preview, Comment May 28, 2026 9:19pm
stack-docs Ready Ready Preview, Comment May 28, 2026 9:19pm
stack-preview-backend Ready Ready Preview, Comment May 28, 2026 9:19pm
stack-preview-dashboard Ready Ready Preview, Comment May 28, 2026 9:19pm

@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR that start with 'DevinAI' or '@devin'.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

📝 Walkthrough

Walkthrough

This 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.

Changes

Loading Indicator Guidance Update

Layer / File(s) Summary
Suspense loading indicator guidance
packages/stack-shared/src/ai/unified-prompts/skill-site-prompt-parts/ai-setup-prompt.ts, docs-mintlify/guides/getting-started/setup.mdx, docs-mintlify/snippets/home-prompt-island.jsx
AI agent guidance for React Suspense loading boundaries is updated to recommend simple indicators (spinner/skeleton/"Loading..."), remove instructions to make them visually appealing or match design, and advise sparing use of broad loading boundaries. The updated prompt text is propagated to the generated docs/snippet files.

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

  • hexclave/stack-auth#1484: Refactors how generatedSetupPromptText is imported/rendered in docs overview; related through shared generated setup prompt content.

Suggested reviewers

  • N2D4
  • nams1570

Poem

🐰 A tweak to prompts, concise and bright,

A spinner whispers, "Hold on, all right."
No grandiose lines to stall the flow,
Just simple loading, steady and slow.
Hoppity-hop, the UX stays light.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Clarify setup prompt loading indicator guidance' directly and clearly summarizes the main change: updating guidance for loading indicators in the setup prompt.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The pull request description is mostly complete, covering the main changes and validation steps performed.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch devin/1780001115-simple-loading-prompt

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 28, 2026

Greptile Summary

This 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.

  • The change is text-only and is gated behind isAiPrompt, so it only affects the AI-agent variant of the prompt and has no impact on the Next.js or React code paths.
  • The new wording aligns with the existing example code (<div>Loading...</div>) in the same code block, avoiding any contradiction for AI agents reading the prompt.

Confidence Score: 5/5

Safe 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

Filename Overview
packages/stack-shared/src/ai/unified-prompts/skill-site-prompt-parts/ai-setup-prompt.ts Single-line text change to the AI-prompt-only loading-indicator guidance note; no logic, imports, or runtime behaviour affected.

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"]
Loading

Reviews (1): Last reviewed commit: "Clarify setup prompt loading indicator g..." | Re-trigger Greptile

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between f80416e and 4db57fb.

📒 Files selected for processing (1)
  • packages/stack-shared/src/ai/unified-prompts/skill-site-prompt-parts/ai-setup-prompt.ts

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 1 file

Reply with feedback, questions, or to request a fix.

Fix all with cubic | Re-trigger cubic

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

Actionable comments posted: 0

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

Actionable comments posted: 0

@Developing-Gamer Developing-Gamer requested a review from N2D4 May 28, 2026 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants