How to Contribute to the Documentation

Contributing to our documentation is a great way to help the community and improve the project for everyone.

Writing Documentation with MDX

We use MDX for our documentation files. MDX allows you to write Markdown with embedded JSX components, while still being easy to write using standard Markdown syntax.

Naming and Placement Conventions

To keep our documentation organized and easy to navigate, the docs are seperated into folders containing either sub-folders (in case there are multiple docs of that type as with the src/app/extensions folder) or a page.mdx in which the documentation is written.

Adding a new File to the Navigation

To make your new documentation discoverable, add it to the navigation menu:

1. Open src/components/Navigation.tsx.
2. Locate the navigation structure it looks something like This

{
  title: 'Contributing', // Title of the Category in which the files will appear
  links: [
    { title: 'Clipboard Server', href: '/contrib/clipboard' },
    { title: 'My super helpful Documentation', href: '/path/to/file.mdx'}
  ],
},

3. Add a new entry for your doc (relative to the /docs directory).