dev-portal — Claude Context

What this repo is

Carriyo's public developer documentation portal at https://carriyo.com/docs. Built with Redocly Developer Portal (@redocly/developer-portal@1.1.0-beta.139).

Stack

  • Content: Markdown ( .md ) + OpenAPI YAML ( .yaml )
  • Config: siteConfig.yaml (nav, OAS definitions, stylesheets), sidebars.yaml (sidebar structure)
  • Dev server: yarn start → http://localhost:3020
  • Build: yarn build | Clean cache: yarn clean

Content structure

Copy
Copied
guides/       integration guides (get started, use cases, connectors, tracking, errors)
api/          API reference pages + OAS YAML files
  core.yaml / shipping.yaml / orders.yaml / returns.yaml / inventory.yaml / authentication.yaml
  *.page.yaml  Redocly page variants referencing OAS operations
carriers/     carrier integration docs (checklist, plug-and-play, requirements)
static/       images, CSS, mermaid diagrams

OAS definitions (registered in siteConfig.yaml)

Key File
core api/core.yaml
authentication api/authentication.yaml
shipping api/shipping.yaml
orders api/orders.yaml
returns api/returns.yaml
inventory api/inventory.yaml

Key conventions

  • Sidebar pages reference either a .md file or an OAS operation via api/<name>.page.yaml#operation/<id>
  • New API pages need entries in both sidebars.yaml and the relevant .page.yaml
  • Keep Markdown frontmatter consistent with existing pages (check a neighbouring file first)
  • Do not edit siteConfig.yaml nav or footer without checking with the user first