Working with Documentation

Thank you for your interest in contributing to the documentation for Miru Web! Your contributions help improve the user experience and make it easier for others to use and understand the application.

Miru Docs now live in the marketing site repository and are built with Astro. This guide walks you through editing the docs content and verifying the result locally.

Installation

1. Fork repository to your account

2. Clone the repo locally

git clone https://github.com/<your-name>/miru-marketing-website.git

3. Navigate to the project directory and install the required dependencies

cd miru-marketing-website
pnpm install

4. Start the development server

pnpm dev

5. Navigate to the local marketing site and open /docs.

Making changes

Document Structure

• Public documentation lives under src/content/docs.

• Use Markdown files (.md) to create or edit documentation pages.

• Maintain a clear and organized folder structure. Each major section or topic should have its own subfolder within src/content/docs.

• Add or update links from the /docs landing page when a new document should be discoverable there.

Writing Style

• Follow the Markdown style guide for consistent formatting.

• Use headings (##, ###, etc.) for section titles.

• Include code blocks where necessary to provide examples or code snippets.

• If you’re referencing code, make sure it’s up-to-date and accurate.

• Use links for cross-referencing to other documentation pages or external resources when relevant.