Runa Developer Hub

This repo contains the documentation for the Runa Developer Hub aka API Docs. This includes the OpenAPI specs for published versions of the API along with content pages. We use Mintlify as a docs framework and hosting provider.

• The docs are hosted at https://developer.runa.io.
• This repository is publicly hosted at https://github.com/wegift/api-docs.

Project Structure

• assets contains graphics and screenshots
• bin contains scripts
• best-practices contains pages under 'Best Practices'
• changelog contains pages under 'Changelogs'
• features contains the feature guides
• getting-started contains the getting started guides
• reference contains the API reference pages including the OpenAPI spec for each version of the API
• snippets contains reusable content for all pages
• styles contains configuration for the spell checker
• docs.json contains the configuration for the docs, new pages need to be referenced in this file
• introduction.mdx is the root page of the guides section
• welcome.mdx is the home page of the site

Writing

Read https://mintlify.com/guides

From content types

• Our tutorial is the 'Getting started' culminating in making your first order
• Our how-to are the feature guides
• Our reference is the 'API Reference' pages generated from the API spec
• Our explanation are the other pages in 'API Reference' and some pages under 'Best Practices'

Content rules

• Do not use level 1 headings (#) in the content, use level 2 headings (##) instead. Level 1 headings are reserved for the page title and break the table of contents.

Development

Install JS packages with pnpm install then run

pnpm dev

A local server will then serve the docs at http://localhost:3000 Hot-reload is supported

⚠️ Note: If you get an error similar to Error: Could not load the "sharp" module using the darwin-arm64 runtime, try installing the pre-built arm64 package like so:

pnpm add @img/sharp-darwin-arm64 --force

and then run pnpm dev.

Mintlify

See Mintlify docs for more information. The docs.json file is the configuration file. Pages are written in MDX, a markdown variant with JSX support.

Publishing Changes

• Make your changes on a branch
• Open a PR and verify the changes from the preview
• Get some review
• Merge to main and the changes are automatically deployed to production