Skip to content

Improve start & ready command documentation#191

Merged
dobrac merged 4 commits intomainfrom
mintlify/improve-start-ready-cmd-docs-1775868858
Apr 11, 2026
Merged

Improve start & ready command documentation#191
dobrac merged 4 commits intomainfrom
mintlify/improve-start-ready-cmd-docs-1775868858

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 11, 2026

Summary

  • Clarified the distinction between setStartCmd and setReadyCmd: setStartCmd accepts two arguments (start command + ready command), while setReadyCmd accepts only one argument (ready command). This was a source of confusion.
  • Added dedicated sections for each method with clear signatures and explanations of when to use each one.
  • Added many more code examples: full template definitions with method chaining, real-world examples (Next.js, Python HTTP server, VNC desktop, nginx), custom shell commands as ready commands, and standalone setReadyCmd usage.
  • Added waitForURL helper to the helpers section (was missing from the original page).
  • Both JavaScript/TypeScript and Python examples provided throughout.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Apr 11, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
e2b 🟢 Ready View Preview Apr 11, 2026, 12:56 AM

Comment thread docs/template/start-ready-command.mdx Outdated
Comment thread docs/template/start-ready-command.mdx Outdated
Comment thread docs/template/start-ready-command.mdx Outdated
Co-authored-by: Jakub Dobry <jakub.dobry8@gmail.com>
@dobrac dobrac merged commit a35be52 into main Apr 11, 2026
7 checks passed
@dobrac dobrac deleted the mintlify/improve-start-ready-cmd-docs-1775868858 branch April 11, 2026 02:38
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