How to update these docs
This site is eventlinx-dev-docs, Docusaurus 3, Cloudflare Pages on main. Keep the existing theme and layout. Replace content; do not revive Facebook Docusaurus tutorials or Swagger Petstore.
Edit
- Branch from
main. - Change Markdown under
docs/, or nav/cards indocusaurus.config.ts,sidebars.ts,src/pages/index.js,src/components/HomepageFeatures/index.js. yarn startlocally.yarn buildmust succeed.- PR to
main. Pages goes live on merge. Do not force-push shared branches.
editUrl on each page points at this repo on GitHub.
What belongs here
- Platform map (who talks to whom).
- Verified behavior: GA vs RS, cart TTL, map lock, auth split, GO gates, predict vs persist.
- Pointers to Event
GET /docand to product repos.
What does not
- Security / PCI / IRP handbooks (client docs). A one-line pointer is enough.
- Invented schemas, migrations, or full route tables.
- Patron self-serve exchange as a shipped product.
- Secrets, tokens, connection strings, example API keys.
- Petstore,
special-key, or Docusaurus “create a page / blog post” clones.
Nav and home cards
Sidebar is explicit in sidebars.ts. If you add a page, add it there and keep homepage feature cards aligned with real sections (they are links, not leftover “General / Guides / Security” tiles).
Navbar GitHub link must stay this repo (EventLinx/eventlinx-dev-docs), not facebook/docusaurus.
OpenAPI
Do not vendor Event’s spec into demo-api-swagger-docs/ unless there is an explicit follow-up to generate API pages. Until then, link GET /doc on the Event hosts. The OpenAPI plugin/theme were removed with Petstore.
Prefer accuracy
If a hostname, flag name, or TTL interpretation is not confirmed in code, say unverified or omit it. Staging Event hosts and the invariants on Ticketing are the current verified set.