Docs : guide deploy-on-clever

[dylanflandpro]

Description

This PR aim to open guides to deploy the app, and starting to add a clever cloud guide to it

Summary by CodeRabbit

• Documentation
  • Added a new deployment guide for Clever Cloud that walks through creating a Clever Cloud app with UI screenshots, configuring required and optional environment variables with a clear template and placeholders, and deploying the project using the Clever Tools CLI. Includes terminal command examples, code snippets for env setup, and a success note confirming the app will be live after deployment.

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

[vercel]

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

Project	Deployment	Preview	Comments	Updated (UTC)
start-ui-web-docs	Ready	Preview	Comment	Dec 10, 2025 9:59am

[coderabbitai]

Walkthrough

Adds a new MDX documentation guide describing how to deploy a Start UI v3 project to Clever Cloud, covering app creation, environment variable configuration (template + placeholders), and deployment commands using the clever-tools CLI.

Changes

Cohort / File(s)	Summary
Documentation / Deployment Guide src/content/docs/guides/deploy-on-clever-cloud.mdx	New MDX guide added. Contains a three-step Steps component with UI instructions and screenshots for creating a Clever Cloud app, an environment variable template with placeholders, and terminal commands (clever-tools) for deploying and releasing the app. Static content only.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single static documentation file.
• Review focus: prose accuracy, MDX formatting, image paths, code block formatting, and consistency with existing docs.

Poem

🐰 I hopped a guide into the cloud,
Steps in paw and instructions proud,
Variables lined in tidy rows,
CLI commands ready — off it goes!
☁️🚀

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 'Docs : guide deploy-on-clever' directly references the main change - adding a deployment guide for Clever Cloud - though it's somewhat abbreviated and uses a branch-like naming convention rather than a natural sentence structure.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/deploy-on-clever

---

📜 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 0729cbd and 04f8725.

⛔ Files ignored due to path filters (4)

• src/assets/guides/deploy-on-clever/deploy-on-clever-1.png is excluded by !**/*.png
• src/assets/guides/deploy-on-clever/deploy-on-clever-3-1.png is excluded by !**/*.png
• src/assets/guides/deploy-on-clever/deploy-on-clever-3-2.png is excluded by !**/*.png
• src/assets/guides/deploy-on-clever/deploy-on-clever-3-3.png is excluded by !**/*.png

📒 Files selected for processing (1)

• src/content/docs/guides/deploy-on-clever-cloud.mdx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/content/docs/guides/deploy-on-clever-cloud.mdx

---

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

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (5)

src/content/docs/guides/deploy.mdx (5)

31-31: Clarify step title formatting.

The instruction text mixed into the step title (*Replace all variables as needed to match your project (including your domain)*) should be moved to the step description for better readability:

-2. Configure environment variables *Replace all variables as needed to match your project (including your domain)*
+2. Configure environment variables
+
+   *Replace all variables as needed to match your project (including your domain)*

---

40-40: Standardize placeholder naming convention.

Line 40 uses "REPLACE ME" (with space) while line 49 uses "REPLACE_ME" (with underscore). Choose one convention consistently:

-   DATABASE_URL="REPLACE_ME"
+   DATABASE_URL="REPLACE ME"

This ensures users can easily identify all placeholders that need replacement.

Also applies to: 49-49

---

51-51: Clarify EMAIL_SERVER placeholder.

Line 51's EMAIL_SERVER="smtp://your-smtp-server" is not clearly marked as a placeholder requiring replacement (unlike other variables using REPLACE ME). Consider standardizing:

-   EMAIL_SERVER="smtp://your-smtp-server"
+   EMAIL_SERVER="REPLACE ME"

or add a comment to clarify it needs configuration.

---

39-59: Consider documenting environment variable purposes.

The environment variable template lacks descriptions for less obvious variables (e.g., VITE_ENV_COLOR, VITE_ENV_EMOJI, VITE_ENV_NAME). A brief comment explaining their purpose would improve usability.

Would you like me to add inline documentation explaining the purpose of key environment variables?

---

61-72: Consider adding troubleshooting and Node version guidance.

The guide would benefit from:

• Node.js version requirement for Clever Cloud deployment
• Common troubleshooting steps if deployment fails
• How to access the deployed app after successful deployment
• How to view real-time logs during deployment

These additions would make the guide more self-contained and reduce support burden.

Would you like me to expand the guide with troubleshooting sections and additional deployment context?

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c8ea910 and fbbee83.

⛔ Files ignored due to path filters (3)

• src/assets/guides/deploy-on-clever/deploy-on-clever-1.png is excluded by !**/*.png
• src/assets/guides/deploy-on-clever/deploy-on-clever-2.png is excluded by !**/*.png
• src/assets/guides/deploy-on-clever/deploy-on-clever-3.png is excluded by !**/*.png

📒 Files selected for processing (1)

• src/content/docs/guides/deploy.mdx (1 hunks)

🔇 Additional comments (1)

src/content/docs/guides/deploy.mdx (1)

20-20: Image assets verified—all files exist.

All three image assets referenced in deploy.mdx are present at the correct paths:

• deploy-on-clever-1.png ✓
• deploy-on-clever-2.png ✓
• deploy-on-clever-3.png ✓

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

src/content/docs/guides/deploy-on-clever-cloud.mdx (1)

29-29: Clarify step title formatting.

The asterisks create markdown emphasis, which may be unintentional. Consider reformatting for clarity—either as separate instructional text below the step or in a callout box to emphasize the requirement.

Current (renders as italics):

2. Configure environment variables *Replace all variables as needed to match your project (including your domain)*

Suggested alternative:

2. Configure environment variables

   **⚠️ Replace all variables as needed to match your project (including your domain)**

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a5ad48a and 0729cbd.

📒 Files selected for processing (1)

• src/content/docs/guides/deploy-on-clever-cloud.mdx (1 hunks)

🔇 Additional comments (1)

src/content/docs/guides/deploy-on-clever-cloud.mdx (1)

1-79: Well-structured deployment guide with good instructional flow.

The guide effectively breaks down the Clever Cloud deployment process into clear, actionable steps with helpful visuals and a comprehensive environment variable template. The past issue with duplicate image alt text has been resolved—each image now has a distinct reference (deploy-on-clever-1, deploy-on-clever-2, deploy-on-clever-3).

[houssembaltii]

I think it would be better to replace “Deploy to Clever Cloud" with a single “Deployment Guide” section, and list the providers directly under it, just like in Astro docs and many more .