Skip to content

docs: domain status workflows and protocol management#2891

Open
atharva-appwrite wants to merge 1 commit intomainfrom
docs/domain-protocol-status-workflows
Open

docs: domain status workflows and protocol management#2891
atharva-appwrite wants to merge 1 commit intomainfrom
docs/domain-protocol-status-workflows

Conversation

@atharva-appwrite
Copy link
Copy Markdown

Summary

  • Domain status documentation: Added a "Domain status" section to the Sites domains, Functions domains, and project custom domains docs pages. Each section documents the four lifecycle states (Verification failed, Generating certificate, Certificate generation failed, Verified) with descriptions and troubleshooting actions in a table format.
  • Protocol management docs: Created a new /docs/advanced/platform/protocols page documenting per-project REST/GraphQL/WebSocket enable/disable, including Console instructions and Server SDK examples. Added to the Platform sidebar navigation and overview page.
  • Changelog entry: Added a 2026-04-16 changelog entry summarizing both the domain status visibility improvements and the new protocol management feature.

Files changed

  • src/routes/changelog/(entries)/2026-04-16.markdoc — new changelog entry
  • src/routes/docs/products/sites/domains/+page.markdoc — added domain status table
  • src/routes/docs/products/functions/domains/+page.markdoc — added domain status table
  • src/routes/docs/advanced/platform/custom-domains/+page.markdoc — added domain status table
  • src/routes/docs/advanced/platform/protocols/+page.markdoc — new protocols docs page
  • src/routes/docs/advanced/platform/+page.markdoc — added Protocols card to Configuration section
  • src/routes/docs/advanced/platform/+layout.svelte — added Protocols to sidebar nav

Test plan

  • Verify changelog entry renders at /changelog
  • Verify domain status tables render correctly on Sites, Functions, and custom domains docs pages
  • Verify new Protocols page renders at /docs/advanced/platform/protocols
  • Verify Protocols link appears in Platform sidebar navigation
  • Verify Protocols card appears on Platform overview page

🤖 Generated with Claude Code

Document the domain verification and certificate status lifecycle
(created/verifying/verified/unverified) across Sites, Functions, and
project custom domains so users can troubleshoot domain setup issues.
Add new Protocols docs page for per-project REST/GraphQL/WebSocket
enable/disable. Add changelog entry covering both features.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@appwrite
Copy link
Copy Markdown

appwrite bot commented Apr 16, 2026

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Failed Failed View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Processing Processing View Logs Preview URL QR Code


Tip

Storage files get ClamAV malware scanning and encryption by default

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 16, 2026

Greptile Summary

This PR adds domain status lifecycle tables (Verification failed → Generating certificate → Certificate generation failed → Verified) to the Sites, Functions, and project custom-domains docs, and introduces a new /docs/advanced/platform/protocols page documenting per-project REST/GraphQL/WebSocket enable/disable. Navigation and the platform overview page are updated accordingly, and a changelog entry is included. The certainly.com CA referenced in the CAA-record troubleshooting steps is correct — the existing TLS docs confirm Appwrite Cloud uses Fastly's Certainly CA for Sites and Functions domains.

Confidence Score: 5/5

Safe to merge — purely additive documentation with no logic changes and no identified errors.

All files are documentation-only; the CA name is verified against the existing TLS docs; SDK enum casing follows the established OAuthProvider.Github pattern; no broken links or structural regressions found.

No files require special attention.

Important Files Changed

Filename Overview
src/routes/changelog/(entries)/2026-04-16.markdoc New changelog entry for domain status visibility and protocol management features; accurate and well-formatted.
src/routes/docs/advanced/platform/+layout.svelte Adds Protocols nav entry between Custom domains and Message templates; correct placement and structure.
src/routes/docs/advanced/platform/+page.markdoc Adds Protocols card to Configuration section and updates description text; consistent with existing card pattern.
src/routes/docs/advanced/platform/custom-domains/+page.markdoc Adds domain status table documenting the four lifecycle states; correctly references certainly.com as the CA (confirmed by TLS docs).
src/routes/docs/advanced/platform/protocols/+page.markdoc New page documenting per-project protocol management; Console steps, Server SDK examples, use-case bullets, and REST-disable warning all look accurate.
src/routes/docs/products/functions/domains/+page.markdoc Replaces the outdated green-badge note with a structured domain status table; content is consistent with sister pages.
src/routes/docs/products/sites/domains/+page.markdoc Inserts domain status table before Domain rule types and adds an anchor ID to that heading; no regressions.

Reviews (1): Last reviewed commit: "docs: add domain status workflows and pr..." | Re-trigger Greptile

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.

1 participant