FLOW: Platform Documentation

This repository contains the documentation for the FLOW platform. The documentation is written in Markdown(-ish) and rendered using Astro and Starlight.

🖋 How to Contribute

Everyone can contribute to the documentation of FLOW. Found a mistake? Want to add a new section? To contribute to the documentation, follow these steps:

• Create a branch
• Make your changes
• Create a merge request
• Get your changes reviewed
• Get your changes merged

🚀 Project Structure

Astro + Starlight uses a file-based routing system. Here's an overview of the project structure:

.
├── public/
├── src/
│   ├── assets/
│   ├── components/
│   │   ├── Header.astro          # picks a header per page
│   │   └── LandingHeader.astro   # nav for the landing page
│   ├── content/
│   │   ├── docs/
│   │   │   ├── index.mdx         # landing page at /
│   │   │   └── docs/             # documentation, served under /docs
│   │   └── config.ts
│   ├── styles/
│   │   ├── custom.css            # theme colours, site-wide
│   │   └── landing.css           # landing page bands and hero
│   └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
npm install	Installs dependencies
npm run dev	Starts local dev server at localhost:4321
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying
npm run astro ...	Run CLI commands like astro add, astro check
npm run astro -- --help	Get help using the Astro CLI

👀 Astro and Starlight Documentation

Check out Starlight’s docs and read the Astro documentation.