Skip to main content

This docs site

These pages are a Docusaurus app in repo-root devdocs/. Production is docs.toern.live on the tyng.app host (same pattern as handbook / sim / tools). The marketing Netlify site only links / redirects to it — it does not embed a docs build.

Layout​

PathRole
devdocs/Docusaurus source (Markdown, config, sidebar)
Public URLhttps://docs.toern.live/ (baseUrl = /)
Server path/var/www/docs.toern.live (Apache; DNS docs.toern.live → docs.tyng.app)

Do not copy a build into website/ or deploy docs as part of the main Netlify site. The operator handbook is separate: repo handbook/ → handbook.toern.live.

Local preview​

cd devdocs
npm install
npm start

Open the URL printed in the terminal (routes are at the site root, e.g. /architecture/overview).

Production build / deploy​

cd devdocs
npm install
npm run build
rsync -avz --delete build/ root@tyng.app:/var/www/docs.toern.live/

Editing content​

  1. Edit Markdown under devdocs/docs/
  2. Sidebar order: devdocs/sidebars.js
  3. Site config / url / baseUrl: devdocs/docusaurus.config.js
  4. Preview with npm start, then commit the source under devdocs/
  • Operator handbook (device usage): repo handbook/ / handbook.toern.live
  • Firmware sketch: repo root toern.ino + toern_*.ino