Update TypeScript plugin documentation

[genu]

Added note about automatic execution of the TypeScript plugin.

Summary by CodeRabbit

• Documentation
  • Clarified that the TypeScript plugin runs automatically during generation and doesn’t require explicit schema declaration unless you need to customize options.
  • Updated guidance on when to include plugin configuration to align with default behavior.
  • No behavioral changes; existing workflows remain unaffected. This clarification aims to reduce setup confusion and set clear expectations for out-of-the-box operation.

[vercel]

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

Project	Deployment	Preview	Comments	Updated (UTC)
zenstack-new-site	Ready	Preview	Comment	Oct 2, 2025 1:02pm

[coderabbitai]

Walkthrough

Added a clarifying note to the TypeScript plugin documentation stating that @core/typescript runs automatically with zenstack generate and only needs explicit declaration for option customization.

Changes

Cohort / File(s)	Summary of Changes
Docs: TypeScript plugin behavior note versioned_docs/version-3.x/reference/plugins/typescript.md	Added a paragraph explaining the plugin auto-runs with zenstack generate even if not declared; declaration is only for customizing options. No functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly captures the main change by indicating an update to the TypeScript plugin documentation and directly aligns with the addition of a clarification note about automatic execution. It is concise, clear, and free of extraneous detail, making it easy for a reviewer to understand the purpose of the pull request at a glance. It accurately reflects the changeset without being overly broad or vague.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 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 22d2ae6 and 17c5228.

📒 Files selected for processing (1)

• versioned_docs/version-3.x/reference/plugins/typescript.md (1 hunks)

🔇 Additional comments (1)

versioned_docs/version-3.x/reference/plugins/typescript.md (1)

11-12: Clear and helpful clarification.

The added note concisely explains the plugin’s default behavior and when manual configuration is necessary. Nicely improves the documentation.

---

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

[ymc9]

Good notes. Thank you @genu !