Skip to Content
Developer Portal preview — pages marked Draft describe the intended design and are not yet available.
CTRL K
Go to Syper Console

Contributing to these docs

How to add and run pages in the Syper Developer Portal.

Add pages by creating .mdx files under apps/developer/content/. Order and titles are set in each folder’s _meta.ts.

Install dependencies

pnpm install

Run the docs locally

pnpm --filter developer dev

Open http://localhost:3009 .

Conventions

  • Top-level sections are the six folders in content/ marked type: "page" in content/_meta.ts. Do not add more top-level sections without an information-architecture review.
  • Keep URLs flat. Group pages in the sidebar with type: "separator" entries in _meta.ts rather than extra folders.
  • Mark availability honestly. Use <Status value="draft" /> for designed-but-unreleased capabilities and <Status value="placeholder" /> for scaffolding. Only use available, beta or planned when there is evidence.
  • Link, don’t duplicate. Concepts live in Essentials, capabilities in Products, connection methods in Integrations, and exact request/response details in the API Reference. End pages with <Related links={[...]} />.
  • Versions are configured in lib/versions.ts, which documents how to archive a version.
Last updated on