Fiberplane Docs

All main Fiberplane Docs are available here as markdown files. To see the rendered preview navigate to our documentation website docs.fiberplane.com

Editing guide

We use ReadMe to render our documentations site and host our markdown that we upload through a Github action workflow.

Page setup - YAML frontmatter

ReadMe sets up the right categories in the sidebar and the right links using the frontmatter at the top of the documentation.

The basic format is:

---
title: Title of your new page
category: <category_id> # the category under which it should be nested
slug: cli # the slug for the cli
---

Adding links to other docs pages

There are also some nuances when adding links. Instead of the normal markdown relative links [linked text](./relative/link) we need to use the following format:

[linked text](doc:the-slug-of-the-linked-piece)