Skip to main content

Getting Started

Local development

Run the site locally from the repository root:

cd src/docs
npm install
npm start

Writing docs

Add pages under docs/docs/ and register them in sidebars.js when needed.

Use frontmatter like this:

---
title: Feature Name
sidebar_label: Feature Name
---

Suggested page template

Each feature page should typically include:

  • overview
  • module or project location
  • dependencies
  • setup steps
  • configuration
  • examples
  • operational considerations

Branding

The site uses the supplied WinnerWare / RDI logo and a theme based on the logo's blue and gray palette.

Keep new assets and illustrations visually aligned with that palette where practical.