tracer-cloud--opensre/docs/README.md

OpenSRE Documentation

This directory contains the source for the OpenSRE documentation, powered by Mintlify.

Local Development

To preview the documentation locally, you need to install the Mintlify CLI.

Prerequisites

• Node.js (version 18 or higher)
• npm

Setup

1. Install the Mintlify CLI globally:

   npm i -g mint
   

2. Run the development server from this directory:

   mint dev
   

   Alternatively, from the project root, you can run:

   make docs-dev
   

The documentation will be available at http://localhost:3000.

Structure

• docs.json: Configuration file for the documentation, including navigation and theme settings.
• *.mdx: Documentation pages written in MDX (Markdown with JSX).
• images/: Static assets such as screenshots and diagrams.
• snippets/: Reusable content blocks.

Contributing

1. Create a new branch for your changes.
2. Edit the relevant .mdx files or update docs.json if adding new pages.
3. Preview your changes locally using mint dev.
4. Submit a Pull Request with a clear description of your changes.

Resources

• Mintlify Documentation
• MDX Syntax Guide