Add project-v docs #1867
Add project-v docs #1867
Conversation
| | Variable | Description | Available at Build and/or Run Time | | ||
| | --- | --- | --- | | ||
| | `APPWRITE_SITE_API_ENDPOINT` | The API endpoint of the running site | Both | | ||
| | `APPWRITE_VERSION` | The Appwrite version used to run the site | Both | | ||
| | `APPWRITE_REGION` | The region where the site will run from | Both | | ||
| | `APPWRITE_SITE_API_KEY` | The site API key is used for server authentication | Build time | | ||
| | `APPWRITE_SITE_ID` | The ID of the running site. | Both | | ||
| | `APPWRITE_SITE_NAME` | The name of the running site. | Both | | ||
| | `APPWRITE_SITE_DEPLOYMENT` | The deployment ID of the running sites. | Both | | ||
| | `APPWRITE_SITE_PROJECT_ID` | The project ID of the running site. | Both | | ||
| | `APPWRITE_SITE_FRAMEWORK_NAME` | The framework of the running site. | Both | |
There was a problem hiding this comment.
@Meldiron need to confirm this list
|
The preview deployment is ready. 🟢 Open Preview | Open Build Logs Last updated at: 2025-04-22 19:40:46 CET |
| The domain usually has this format. | ||
|
|
||
| ```bash | ||
| https://64d4d22db370ae41a32e.sites.appwrite.global |
There was a problem hiding this comment.
Confirm with CHristy, I think all domains will become .network on sites.
For functions, .network will also be available, but I think they will also support .run, for region-specific run. Check that with christy too; we may want that rework as separate PR, but for Sites, let's have new docs accurate
Co-authored-by: Khushboo Verma <[email protected]>
Co-authored-by: Khushboo Verma <[email protected]>
Co-authored-by: Khushboo Verma <[email protected]>
| @@ -70,6 +70,12 @@ | |||
| href: '/docs/products/ai', | |||
| icon: 'icon-chip', | |||
| isParent: true | |||
| }, | |||
| { | |||
| label: 'Sites', | |||
| @@ -48,6 +48,9 @@ Deploy and scale serverless functions in secure, isolated runtimes. | |||
| {% cards_item href="/docs/references/cloud/server-nodejs/messaging" title="Messaging" %} | |||
| Send push notifications, SMS, or emails to users or groups of users using your app. | |||
| {% /cards_item %} | |||
| {% cards_item href="/docs/references/cloud/server-nodejs/sites" title="Sites" %} | |||
There was a problem hiding this comment.
Let's have this before Storage
| @@ -71,6 +71,11 @@ | |||
| icon: 'icon-send', | |||
| href: `${prefix}/messaging` | |||
| }, | |||
| { | |||
| label: 'Sites', | |||
There was a problem hiding this comment.
Let's have this before Storage
There was a problem hiding this comment.
Can we link directly to the server specs on services with no client specs like Sites and Users?
| description: Explore how hosting works on Appwrite Sites. | ||
| --- | ||
|
|
||
| There are two rendering methods you can use to host your web app on Appwrite Sites. |
There was a problem hiding this comment.
This page should have a lot more depth, both for users first exploring this concepts and also for SEO.
I also don't think the title/path is a best fit. I would just call this Rendering or Rendering strategies I think the overview needs to go more in depth into the differences between the strategies.
| {% cards_item href="/docs/products/sites/site-hosting/static" title="Static" %} | ||
| Host a static site or SPA | ||
| {% /cards_item %} | ||
|
|
||
| {% cards_item href="/docs/products/sites/site-hosting/ssr" title="Server Side Rendering" %} | ||
| Host an SSR web app | ||
| {% /cards_item %} |
There was a problem hiding this comment.
Let's be consistent sites vs web app vs website
|
|
||
| # Manual Deployment | ||
|
|
||
| You can upload your sites to be deployed using the Appwrite Console. The example below shows a skeleton SvelteKit app. |
There was a problem hiding this comment.
Would be good to add a screenshot here.
| # Configuring your Appwrite Site to use static hosting | ||
|
|
||
| When Appwrite builds your site for the first time, it scans your project's configuration files to determine whether the website should be rendered as static pages or using SSR. | ||
|
|
There was a problem hiding this comment.
Everywhere we ask to change settings on the console a screenshot would be very helpful.
|
|
||
| To enable SSR builds for your web app, you may need to make some additional updates in case of the following frameworks: | ||
|
|
||
| {% tabs %} |
There was a problem hiding this comment.
This part doesn't work on my preview.
|
|
||
| If you need to manually update these settings, here are the steps to do so: | ||
|
|
||
| 1. Navigate to your site in the Appwrite Console and head to the **Settings** tab > **Build settings** section |
| description: Learn how to host SSR web apps on Appwrite Sites. | ||
| --- | ||
|
|
||
| Server Side Rendering (SSR) apps generate HTML content dynamically on the server for each request and send fully rendered pages to the browser. This approach improves performance for the initial load and enhances SEO since search engines can easily index the content. While SSR can be slightly slower than static apps due to server-side processing, it provides a good balance between performance and interactivity. |
There was a problem hiding this comment.
I miss some connection to our edge network. I would add here some explanation of the Appwrite CDN, Edge, Region topology with relevant links. Bottom line: we have a CDN, your executions will happen on the nearest regions to the user, your data is stored in your region of choice.
What does this PR do?
Adds project-v docs
Pending work:
Test Plan
pnpm i && pnpm run devRelated PRs and Issues
Have you read the Contributing Guidelines on issues?
Yes