Skip to main content

Standard template

This article outlines the key requirements that all contributors and project participants must adhere to in order to maintain clarity and consistency in our documentation.

Formatting

All documentation should be saved in the .mdx format to support both Markdown and JSX components. Each document must include front matter at the top, which is a YAML block that sets the file's metadata.

Standard Doc
---
title: "Getting Started with Our Project"
description: "A comprehensive guide for new contributors."
---

# Project Title

## Overview
A brief description of the project and its purpose.

## Features
- Key features and functionalities.

## Getting Started

### Prerequisites
- Required software or tools.

### Installation
1. Step-by-step installation instructions.
2. Additional setup instructions if necessary.

## Usage
- Examples of how to use the project.
- Include code snippets if applicable.

## Contributing
- Guidelines for contributing to the project.
- Link to the contribution guidelines document.

## License
- Licensing information.


## Contact
- Contact information for project maintainers.

Front Matter

Each document must include front matter at the top. This is a YAML block that sets metadata for the file.

Title and Description

Ensure that both the title and description fields are present in the front matter. The title should clearly indicate the content of the document, while the description provides a brief overview.

---
title: "Getting Started with MDX"
description: "A guide to help you understand and use MDX format in our documentation."
---