Skip to content

docs: add explanation about theme access in StyleSheet.create API and web error #916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 14, 2025

Conversation

jpudysz
Copy link
Owner

@jpudysz jpudysz commented Jul 14, 2025

Summary

Explains better web error while following tutorial.

Fixes:

Summary by CodeRabbit

  • Documentation
    • Added an informational aside explaining how to access the theme object with Unistyles' StyleSheet in the tutorial.
    • Provided guidance for users encountering issues when following the tutorial on the web, advising focus on iOS for now.

Copy link

vercel bot commented Jul 14, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
react-native-unistyles-2.0 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 14, 2025 8:11am
react-native-unistyles-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 14, 2025 8:11am

Copy link

coderabbitai bot commented Jul 14, 2025

Walkthrough

An informational aside was added to the tutorial documentation, explaining how to access the theme object when using Unistyles' StyleSheet compared to the standard React Native API. The aside also provides guidance for users encountering issues on the web platform and clarifies the focus on iOS support in the tutorial.

Changes

Files Change Summary
docs/src/content/docs/v3/tutorial/cleanup-screens.mdx Added an informational aside explaining theme access differences and web platform considerations.
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/docs

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@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: 0

🧹 Nitpick comments (2)
docs/src/content/docs/v3/tutorial/cleanup-screens.mdx (2)

145-147: Use the same code-fence metadata pattern used elsewhere

Other snippets in this doc use the title="<path>" lang="tsx" syntax.
Keeping the pattern consistent avoids rendering quirks in Starlight and helps readers quickly spot the file path.

-```tsx /theme/
+```tsx title="/theme" lang="tsx"

152-154: Provide a direct link to the web-setup guide or the referenced issues

Readers hitting the web error will appreciate an immediate pointer instead of having to search. Consider adding links to the future web-setup section or directly to issues #913 and #904.

Example:

For now, focus on iOS. We'll show you how to get it working on the web later — see
[our web setup guide](../web-setup) or follow progress in
[#913](https://github.com/jpudysz/react-native-unistyles/issues/913) and
[#904](https://github.com/jpudysz/react-native-unistyles/issues/904).
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cb5e4e1 and 181421f.

📒 Files selected for processing (1)
  • docs/src/content/docs/v3/tutorial/cleanup-screens.mdx (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). (1)
  • GitHub Check: lint

@jpudysz jpudysz merged commit de519c9 into main Jul 14, 2025
5 checks passed
@jpudysz jpudysz deleted the feature/docs branch July 14, 2025 08:14
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.

1 participant