mirror of
https://github.com/ever-co/ever-gauzy.git
synced 2026-11-15 14:04:15 +08:00
Develop gained 1791000008300 (chat webhook interaction idempotency key) since the last renumber. migration-timestamps spec: 7/7. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Ever Gauzy documentation
The Ever Gauzy documentation does not live in this repository. It is written in
ever-co/ever-gauzy-docs and published at
docs.gauzy.co. This folder only points there.
Read
| What | Where |
|---|---|
| 📖 Platform documentation | docs.gauzy.co |
| 🚀 Quick start | docs.gauzy.co/getting-started/quick-start |
| 🛠️ Installation | docs.gauzy.co/getting-started/installation |
| 📡 API overview | docs.gauzy.co/api/overview |
| 🧪 Live API reference (Swagger) | api.gauzy.co/docs |
| 🚢 Deployment (Kubernetes) | docs.gauzy.co/deployment/kubernetes |
| 🐳 Deployment (Docker Compose) | docs.gauzy.co/deployment/docker/docker-compose |
| 💻 Contributing to Gauzy | docs.gauzy.co/development/contributing |
| 📚 Wiki | github.com/ever-co/ever-gauzy/wiki |
Use
| What | Where |
|---|---|
| 🌐 Website | gauzy.co |
| ⬇️ Downloads (server, apps) | gauzy.co/downloads |
| ☁️ Ever Gauzy SaaS | app.gauzy.co |
| 🎮 Demo (resets daily) | demo.gauzy.co |
Write or fix a page
Open a pull request in ever-co/ever-gauzy-docs, not here:
- the site is a Docusaurus app in
website/; the pages are Markdown underwebsite/docs/, one folder per section of the sidebar; - base the pull request on
develop(masteris what docs.gauzy.co publishes); - run it locally with
yarn installthenyarn startinwebsite/.
A page that would have gone in docs/<section>/ of this repository goes in website/docs/<section>/ there.
Every page on docs.gauzy.co has an "Edit this page" link to its source.
Pages that used to be here
These two pages are generated from code in this repository, and a CI check fails when a page drifts from
that code, so the copy the check reads stays beside its generator under tools/. The published page is a
copy of it; regenerate the copy here, then copy the change to the docs repository.
| Was | Published at | Copy checked by CI here |
|---|---|---|
docs/ever-platform/outbound-calls.md |
docs.gauzy.co/ever-platform/outbound-calls | tools/ever-platform/outbound-calls.md (node tools/ever-platform/outbound-calls.mjs --check) |
docs/platform-extensions/design-name-triage.md |
docs.gauzy.co/platform-extensions/design-name-triage | tools/scripts/design-name-triage.md (node tools/scripts/design-name-triage-check.mjs) |