Optimum Docs

Welcome to the official documentation repository for Optimum. Here you'll find comprehensive guides, tutorials, and reference materials to help you make the most out of Optimum.
Explore the docs »

Report Bug · Request Feature

Getting Started

This section describes how you can get our documentation portal up and running on your machine.

Prerequisites

• node
• yarn
• vitepress

Installation

1. Clone the repo

   $ git clone https://github.com/getoptimum/docs.git

2. Install dependencies

   $ yarn install

3. Run the docs site

   $ make run-dev

Directory Structure

docs/
├── how-to-guides   # Guides and tutorials
└── learn           # Overview and primer material

Contribution Guidelines

We love contributions from the community! Whether you're fixing typos, improving content clarity, or adding new topics, every contribution helps.

• Fork & clone: Fork this repository and clone it to your local machine.
• Branch: Always create a new branch for your changes. Naming it relevantly.
• Commit Changes: Make your changes and commit them with a clear and concise commit message.
• Push & Create PR: Push your changes to your fork and create a pull request to the main branch of this repository.

Please ensure to review the detailed Contribution Guidelines above before making a pull request.

Link Format Guidelines

When adding internal links to documentation, please use the following format: [link text](/base-working-dir/subdir/page.md#section-id), i.e. [link text](/how-to-guides/quick-start.md#get-your-auth-token)

This format ensures long-term compatibility and consistent behavior across different platforms and documentation builds.

Feedback & Suggestions

We value feedback from the community. If you have suggestions for improvements or find any discrepancies in the documentation, please raise an issue in this repository.