Docs

Docs is the product that contains Fluid Attacks’ development documentation.

Public Oath

The documentation is located at: dev.fluidattacks.com.

Architecture

---

1. Docs is a static site built with Astro Starlight.
2. It uses MDX files to store its content.
3. It uses Cloudinary as main multimedia host.
4. The website is hosted on GitLab Pages.

Contributing

Please read the contributing page first.

Update documentation as you work

In order to make documentation maintenance as simple as possible, changes to common/docs/src/content are allowed on all pipelines.

That is, you can work on your current product and also update documentation at common/docs/src/content, all within the same merge request.

Example

1. Change files at integrates/back.
2. Update documentation at common/docs/src/content.
3. Create an integrates\ commit.
4. Wait for the integrates pipeline to pass.
5. Create a merge request.

Running jobs

Any script described in docs package.json can be executed as following:

m . /common/docs <script-name>

Some examples are:

Local environment

m . /common/docs dev

Lint

m . /common/docs lint

Build

m . /common/docs build

Editor support

In order to enable syntax highlighting, linting and formatting in your editor you need to:

1. Have the MDX extension installed.
2. Make common/docs/node_modules locally available. You can do so by running any docs job as described in Running jobs.

Using components

Components help your documentation look beautiful with things like cards, asides, steps, etc.

.mdx files support the use of JSX components. Both native and custom components are supported.

You can find all supported components in the table below.

Type	Documentation
Native	Link
Custom	Link