Skip to content

DreamyDuck/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scarlet Documentation

This repository contains the official documentation for Scarlet Technology, built with Mintlify.

About Scarlet

Scarlet provides cutting-edge DMA (Direct Memory Access) technology for gaming and development. Our documentation covers everything from getting started with Scarlet devices to advanced development using our API.

Documentation Structure

  • Introduction - Overview of Scarlet and DMA technology
  • Quickstart Guide - Setting up your Scarlet device
  • Development Guide - Using the Scarlet SDK for development
  • API Reference - Detailed API documentation for developers
  • Essentials - Documentation components and formatting

Development

To work on this documentation locally, follow these steps:

Prerequisites

Install the Mintlify CLI to preview the documentation changes locally:

npm i -g mintlify

Local Development

Run the following command at the root of your documentation (where docs.json is):

mintlify dev

This will start a local development server at http://localhost:3000 where you can preview your changes.

Publishing Changes

Changes to the main branch will automatically be deployed to the Scarlet documentation website.

Contributing

We welcome contributions to improve our documentation. Please submit a pull request with your proposed changes.

Support

If you need help with Scarlet products or have questions about the documentation, please visit our Discord community or contact [email protected].

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published