Markdown documentation

Workspace document

The workspace Documentation path offers a general Markdown document for the project: vision, conventions, internal links, etc.

Per-collection document

Inside each collection you can edit Markdown associated with the API (description, guides, examples). The editor usually includes a preview and, in teams, version control or conflicts similar to other documents.

Best practices

• Structure with clear headings (##, ###).
• Link to environments and evidence when describing end-to-end flows.
• Keep the content aligned with the OpenAPI and imported collections.