Skip to main content
  • Send to AI

Contributing To The Docs

How to contribute to the docs​

To add an article you can go to this link, click on the "docs" folder and select the folder that corresponds to the topic to which you are going to contribute.

How to create a new documentation page​

To create a new documentation page, click on the icon to add a new file.

In case you need to add a new section, you must first add a folder inside "docs", and then create a file inside it to write the article.

How to edit an exiting page​

To edit an existing article, locate the file and within the edit box update what you need.

Alternatively, you can also just click on the link that says "Edit this page" on the bottom left corner of every page.

When you are done, click on the "Create commit" button in the bottom left margin. Add in the comments the changes you made and then merge the changes to the internal branch.

Frontmatter requirements​

Every page must declare its frontmatter in this exact field order. The validator (yarn validate) rejects pages that miss a required field, mismatch their slug against the file name, or use underscores in id/slug.

---
id: my-new-page
slug: my-new-page
title: 'My New Page'
sidebar_label: 'My New Page'
sidebar_position: 1
created_at: 2026-05-05
author: 'Engineering Team'
tags: [topic, area]
---

Validate before opening an MR​

Run these from the repo root before pushing:

yarn validate              # Checks frontmatter, slugs, headings, structure
yarn build:engineering     # Catches broken links and Docusaurus errors

If yarn validate reports issues, yarn fix can apply mechanical corrections (slug normalization, field reorder) for you to review.

Style notes​

  • One H1 (#) per page. Subsequent sections use H2/H3.
  • Prefer relative links between docs in the same plugin instance (./neighbor.md, ../sibling/page.md).
  • For cross-plugin links (engineering → product, product → public, etc.), use pathname:///<route>.
X

Graph View