docs: import ever-gauzy's docs/ pages (Ever Platform outbound calls, platform-extensions design-name triage)

Merged
EV
13d ago
+283-0

What

Moves everything that was under ever-co/ever-gauzy docs/ into this repository, so docs.gauzy.co is the one place for Gauzy documentation. The companion PR ever-co/ever-gauzy#10639 leaves only a docs/README.md there, pointing to docs.gauzy.co, this repository, the website and so on.

There were two pages. Each gets a sidebar section that mirrors its old folder, so a page that would have gone in ever-gauzy's docs/<section>/ has an obvious home here (website/docs/<section>/):

ever-gauzy (was)hereURL
docs/ever-platform/outbound-calls.mdwebsite/docs/ever-platform/outbound-calls.md (new section šŸŒ Ever Platform, position 27)/ever-platform/outbound-calls/
docs/platform-extensions/design-name-triage.mdwebsite/docs/platform-extensions/design-name-triage.md (new section šŸ›’ Platform Extensions, position 28)/platform-extensions/design-name-triage/
  • What Ever Gauzy sends to Ever Platform: every call the optional statistics and connection modules can make, when nothing is sent, and how to verify it yourself. This is the transparency page self-hosters look for.
  • Platform extensions ā€” the phantom design names, triaged: the 81 GraphQL root fields the platform-extensions design named, each with its decision.

Same content, adapted for MDX

The body text of each page matches its ever-gauzy source word for word. The only changes:

  • front matter (sidebar_position, description)
  • links into the ever-gauzy tree (../../packages/..., ../../tools/...) point to GitHub (blob/develop), because onBrokenLinks: "throw" would otherwise fail
  • { } in one table cell (outside inline code) are escaped, since MDX would read them as an expression
  • the markdownlint-disable MD013 MD043 pragma of the outbound-calls source is kept, and the triage page gets the same one (Codacy flagged their long table rows); it renders nothing

Plus hostnames, tcpdump and ZITADEL in .cspell.json.

Keeping them in step

Both pages are generated in ever-gauzy, and a CI gate there checks its own copy: tools/ever-platform/outbound-calls.md (outbound-calls.mjs --check) and tools/scripts/design-name-triage.md (design-name-triage-check.mjs). The copies here are published copies. Each page, and each generator's header, names the other copy. When the source changes, regenerate it in ever-gauzy and copy the change here (node tools/scripts/design-name-triage-check.mjs --markdown prints the triage page).

Checked

  • yarn build (English, as the k8s image builds it): passes with onBrokenLinks: "throw". Both pages and both category indexes are generated, and the sidebar lists both sections.
  • Rendered HTML: the expected titles and meta descriptions; table rows 32 (5 + 13 + 11 plus 3 headers) and 82 (81 plus a header); the escaped cell renders as tenant {product_tenant_id, product_org_id?, display_name}?; the three GitHub links; the "Edit this page" link goes to blob/develop/website/docs/....
  • cspell on both pages: 0 issues.
  • Side observation, not from this PR: the built HTML of this site carries stray NUL bytes next to emoji and em dashes (62 in a local build of develop plus this PR, spread over pages this PR does not touch; the live /deployment/ci-cd/circleci/ has one too).

šŸ¤– Generated with Claude Code