Documentation
Contribute to the OrcaCD website or documentation
This guide explains how to add or edit the OrcaCD documentation. The source code of the documentation is stored in the OracaCD/docs GitHub repository.
Where docs live
All markdown pages are under /content/docs. The file meta.json controls the sidebar structure and order.
Adding a new page
- Pick the correct folder that matches a collection pattern (e.g.
/guides). - Create
/content/docs/<section>/<slug>.md. - Add the frontmatter code:
---
title: Installation
description: Get OrcaCD running quickly with Docker installation
---- Run
npm run devand check your page athttp://localhost:3000/docs/<section>/<slug>.
Components
To use components in the documentation please look at the Fumadadocs Documentation for Markdown
Submitting changes
After making changes you can create a pull request to the main branch. Please make sure to commit using Conventional Commits (docs: update guides).
Thanks for helping out!
Last updated on