docs (docs): setup/teardown script added to docs

[AviPeltz]

Description

Related Issues

Type of Change

• Bug fix
• New feature
• Documentation
• Refactor
• Other (please describe):

Testing

Screenshots (if applicable)

Additional Notes

Summary by CodeRabbit

• Documentation
  • Added a new guide page documenting setup and teardown scripts, including configuration via config.json, JSON schema structure, command execution methods, workspace lifecycle integration, and implementation guidance.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Two documentation files are modified to introduce a new guide page about setup and teardown scripts for Superset workspace initialization and cleanup. The navigation metadata is updated, and a new documentation page is added with configuration details and practical examples.

Changes

Cohort / File(s)	Change Summary
Documentation Navigation apps/docs/content/docs/meta.json	Added new page slug "setup-teardown-scripts" to the "How to Guides" section in the documentation navigation index
Documentation Content apps/docs/content/docs/setup-teardown-scripts.mdx	New documentation page detailing setup and teardown script configuration via config.json, execution behavior on workspace creation/deletion, and usage patterns for shell scripts and inline commands

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A guide for scripts that setup and tear down,
Workspaces bloom and gracefully bow,
Configuration flows, commands take flight,
Documentation shines, crystal and bright! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is empty except for template headings; all sections lack substantive content or details about the changes.	Complete all template sections with relevant information: describe what setup/teardown scripts do, link any related issues, mark 'Documentation' as the change type, and add context about the new documentation page.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: adding setup/teardown script documentation to the docs.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

---

🧹 Recent nitpick comments

apps/docs/content/docs/setup-teardown-scripts.mdx (1)

1-76: Well-structured documentation with clear examples.

The documentation is clear, well-organized, and provides practical examples. The progression from overview to configuration to practical tips is logical and easy to follow.

Consider adding the following sections to make the documentation more complete:

1. Error Handling: What happens if a setup command fails? Does workspace creation abort, or does it continue? Users should know the expected behavior.

2. Security Considerations: Since this feature executes arbitrary shell commands, consider adding a note about:

   • Only running trusted scripts
   • Being cautious with commands in shared repositories
   • The scripts run with the user's permissions

3. Shell Environment (optional): Clarify which shell executes the commands (e.g., bash, sh, or the user's default shell) and whether any special environment variables are available.

📝 Example additions

After the "How It Works" section, you could add:

## Error Handling

If a setup command fails (returns a non-zero exit code), the workspace creation process stops and the error is displayed in the terminal. The workspace and worktree are still created, but you'll need to fix the issue and re-run the setup manually.

Teardown commands run on a best-effort basis - if one fails, subsequent commands still execute.

## Security Considerations

⚠️ **Warning**: Setup and teardown scripts execute with your user permissions. Only run scripts you trust, especially in shared repositories. Review scripts before enabling them in your workspace.

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c5f0b67 and e0fd5d8.

⛔ Files ignored due to path filters (1)

• bun.lock is excluded by !**/*.lock

📒 Files selected for processing (2)

• apps/docs/content/docs/meta.json
• apps/docs/content/docs/setup-teardown-scripts.mdx

⏰ 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). (6)

• GitHub Check: Deploy Web
• GitHub Check: Deploy Marketing
• GitHub Check: Deploy Admin
• GitHub Check: Deploy Docs
• GitHub Check: Deploy API
• GitHub Check: Build

🔇 Additional comments (1)

apps/docs/content/docs/meta.json (1)

11-12: LGTM! Navigation entry added correctly.

The new page slug is properly positioned under the "How to Guides" section and follows the correct JSON array syntax.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

---

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

[github-actions]

🚀 Preview Deployment

🔗 Preview Links

Service	Status	Link
Database (Neon)	✅	View Branch
Electric (Fly.io)	✅	View App
API (Vercel)	✅	Open Preview
Web (Vercel)	✅	Open Preview
Marketing (Vercel)	✅	Open Preview
Admin (Vercel)	✅	Open Preview
Docs (Vercel)	✅	Open Preview

---

Preview updates automatically with new commits