docs: move docs/ to ever-gauzy-docs, keep only a README that points to docs.gauzy.co
PR
- Have you followed the contributing guidelines?
- Have you explained what your changes do, and why they add value?
What
The Ever Gauzy documentation lives in ever-co/ever-gauzy-docs and is published at docs.gauzy.co. This PR leaves docs/ holding a single docs/README.md that points there, so anyone who opens the folder finds the docs:
- docs.gauzy.co plus its most-used entry points (quick start, installation, API overview, Kubernetes / Docker Compose deployment, contributing), the live API reference (
api.gauzy.co/docs), and the wiki - the website, downloads, SaaS (
app.gauzy.co) and demo - how to write or fix a page: a PR in
ever-gauzy-docsagainstdevelop, Docusaurus inwebsite/ - a table of the pages that used to be here and where each one went
The two pages that were in docs/ are published in ever-co/ever-gauzy-docs#152 under the same section names:
| Was | Published at | Copy the CI check reads, now |
|---|---|---|
docs/ever-platform/outbound-calls.md | https://docs.gauzy.co/ever-platform/outbound-calls/ | tools/ever-platform/outbound-calls.md |
docs/platform-extensions/design-name-triage.md | https://docs.gauzy.co/platform-extensions/design-name-triage/ | tools/scripts/design-name-triage.md |
Why the two pages keep a copy under tools/
Both pages are generated, and a gate fails when a page drifts from its source:
node tools/ever-platform/outbound-calls.mjs --check(egress-audit.yml) compares the page's generated tables with the pinned Ever Platform contract.node tools/scripts/design-name-triage-check.mjs(static-checks.yml) refuses a page that differs from its triage table.
A gate in this repository can only read a file in this repository. So the copy each gate reads moves out of docs/ to sit next to its generator, and every check stays exactly as strict as before. The published page on docs.gauzy.co is a copy of it. Each copy names the other: the generators' headers, a "Where it lives" paragraph in the triage page, and a note in the outbound-calls page.
Everything that pointed at the old paths now points at the new ones:
outbound-calls.mjs(DOCS, messages, header)design-name-triage-check.mjs(MARKDOWN, header; the page is regenerated with--write)egress-audit.yml(comment; thedocs/ever-platform/**path filters go, sincetools/ever-platform/**already covers the file)- the
ALLOWEDlist instatic-hostnames.mjsand its test ('docs/ever-platform/'goes, sincetools/ever-platform/and**/*.mdalready cover the file) tools/egress-audit/README.mdPLATFORM-EXTENSIONS.md
How it was checked (locally: PRs into develop start no workflow)
| Check | Before (develop 77606f6199) | After |
|---|---|---|
node tools/scripts/design-name-triage-check.mjs | PASSED, "the published table matches" | PASSED, "the published table matches" |
node tools/ever-platform/outbound-calls.mjs --check | ok (contract 1.0.0-rc.6; 13 made, 11 not made) | ok (same) |
node --test tools/ever-platform/outbound-calls.test.mjs | 4/4 | 4/4 |
node --test tools/egress-audit/static-hostnames.test.mjs | 6/7 | 6/7, same single failure |
The one static-hostnames failure is already on develop and unrelated: .github/workflows/upgrade-test.yml: packages.ever.co x1 (recorded: 0), from 57195404ab. The egress-audit inputs job on develop is also red for another reason that predates this PR: tools/egress-audit/ui-routes.json is out of step with the router (run 38658699130). This PR fixes neither and makes neither worse. An earlier draft did add docs.gauzy.co to design-name-triage-check.mjs, and that same test caught it. The hostname now stays in the Markdown only.
🤖 Generated with Claude Code
Summary by cubic
Moves the Ever Gauzy documentation out of docs/ and into ever-co/ever-gauzy-docs, published at docs.gauzy.co. docs/ now holds only a README pointing to the published docs, the docs repository, and where to write or fix pages.
The two generated pages that CI checks move out of docs/ to sit beside their generators under tools/, so every gate keeps reading the same content from this repository. The published copies on docs.gauzy.co are kept in sync manually; each copy names where the other lives.
docs/ever-platform/outbound-calls.md→tools/ever-platform/outbound-calls.md(check:node tools/ever-platform/outbound-calls.mjs --check)docs/platform-extensions/design-name-triage.md→tools/scripts/design-name-triage.md(check:node tools/scripts/design-name-triage-check.mjs)- Updated the generators, the
egress-audit.ymlpath filters, thestatic-hostnames.mjsallow list and its test, and the READMEs that linked the old paths. - The outbound-calls page now shows the local audit setup from the egress-audit README and notes it must run at the root of an
ever-co/ever-gauzycheckout, since docs.gauzy.co readers have notools/egress-audit. docs/README.mdstarts with the repository's markdownlint pragma (MD013,MD043) so its link tables and heading structure pass Codacy.