add stackAuthComponent to convex readme

[BilalG1]

Summary by CodeRabbit

• Documentation
  • Added integration guidance and example configuration for setting up Stack Auth with Convex, including app initialization and client configuration instructions.

[coderabbitai]

Walkthrough

The change adds documentation to the Convex integration README, demonstrating how to configure convex.config.ts to register the Stack Auth component with a Convex application using defineApp() and app.use().

Changes

Cohort / File(s)	Summary
Convex integration configuration docs packages/template/src/integrations/convex/component/README.md	Added example code block showing convex.config.ts setup, including defineApp() usage, stackAuthComponent registration, and app export

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• Documentation-only change with example code additions
• No logic, exports, or behavioral modifications

Possibly related PRs

• add stackAuthComponent to convex readme #999: Directly modifies the same Convex README to add the convex.config.ts example with stackAuthComponent registration.
• fix convex docs #953: Updates Convex integration documentation to demonstrate Stack Auth wiring for client-side authentication usage.

Suggested reviewers

• N2D4

Poem

🐰 A config file hops into view,
Convex and Stack Auth, now bound as two,
With defineApp() and stackAuthComponent true,
The integration docs are fresh and new! 🌟

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description contains only the template comment about CONTRIBUTING.md guidelines with no actual description or explanation of the changes made.	Add a meaningful description explaining what was added to the Convex readme, why the change was made, and any relevant implementation details or context for reviewers.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: adding stackAuthComponent documentation to the Convex readme.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch update-convex-readme

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e824e8c and 2648e3c.

📒 Files selected for processing (1)

• packages/template/src/integrations/convex/component/README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)

• GitHub Check: docker
• GitHub Check: all-good
• GitHub Check: restart-dev-and-test
• GitHub Check: build (22.x)
• GitHub Check: check_prisma_migrations (22.x)
• GitHub Check: setup-tests
• GitHub Check: restart-dev-and-test-with-custom-base-port
• GitHub Check: build (22.x)
• GitHub Check: lint_and_build (latest)
• GitHub Check: build (22.x)
• GitHub Check: Security Check
• GitHub Check: build (22.x)
• GitHub Check: Security Check

🔇 Additional comments (1)

packages/template/src/integrations/convex/component/README.md (1)

31-44: Documentation addition is clear and well-integrated.

The new section properly documents the convex/convex.config.ts setup step with appropriate framework variations, maintaining consistency with the preceding auth.config.ts example and logical flow into the client configuration that follows. The code examples are syntactically correct and demonstrate the idiomatic Convex integration pattern.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[greptile-apps]

Greptile Overview

Greptile Summary

Added a missing configuration step for setting up the Convex app with Stack Auth component. The new section instructs developers to create convex/convex.config.ts and import stackAuthComponent from the appropriate Stack Auth package (@stackframe/js, @stackframe/react, or @stackframe/stack).

• All three package imports have been verified to exist and export ./convex.config
• The code example matches the existing implementation in examples/convex/convex/convex.config.ts
• This step is required for proper Convex integration and was previously missing from the documentation

Confidence Score: 5/5

• This PR is safe to merge with no risk - it only adds missing documentation
• The change is a documentation-only update that adds a crucial missing step to the Convex integration guide. All imports and code examples have been verified against the actual package exports and working example code. No functional code changes were made.
• No files require special attention

Important Files Changed

File Analysis

Filename	Score	Overview
packages/template/src/integrations/convex/component/README.md	5/5	Added configuration step for convex.config.ts with correct imports and usage of stackAuthComponent

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Auth as auth.config.ts
    participant Config as convex.config.ts
    participant Client as Convex Client
    participant Stack as Stack Auth

    Dev->>Auth: Create auth.config.ts
    Auth->>Stack: getConvexProvidersConfig(projectId)
    Stack-->>Auth: Return providers config
    
    Dev->>Config: Create convex.config.ts
    Config->>Stack: Import stackAuthComponent
    Config->>Config: defineApp() & app.use(stackAuthComponent)
    
    Dev->>Client: Setup Convex client
    Client->>Stack: stackClientApp.getConvexClientAuth()
    Stack-->>Client: Return auth config
    Client->>Client: convexClient.setAuth()

Loading

_{1 file reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}