Dot Ring Documentation Site

This repository hosts the Docusaurus-powered documentation for Dot Ring.

Prerequisites

Ensure you have Node.js 18 or newer:

node -v

Installation

Install dependencies:

npm install

Local Development

Start a local dev server (hot-reload enabled):

npm start
# or
npm run server

Visit: http://localhost:3000

Build

Generate the static site in build/:

npm run build

Preview the build locally:

npm run serve
# pick a different port if 3000 is busy
npm run serve -- --port 4000

Deploy

If hosting on GitHub Pages, update url, organizationName, and projectName in docusaurus.config.js, then:

npm run deploy

Structure

docs/          # Markdown source
sidebars.js    # Sidebar configuration (autogenerated)
src/css/       # Custom CSS overrides
static/        # Static assets like images

Extend

• Add more markdown files under docs/
• Customize theme in docusaurus.config.js
• Add versioning later with docusaurus docs:version <x.y>

License

Add your license info here.