Updating the Manual

The StoryCAD user manual is built using Jekyll with the Just the Docs theme. Documentation files are written in Markdown and located in the docs folder.

Serving Documentation Locally

You can preview the manual locally before publishing. Changes to markdown files will automatically refresh in the browser.

Prerequisites

  • Ruby - Install via RubyInstaller (Windows) or brew install ruby (macOS)
  • PowerShell Core - Comes with Windows; install via brew install powershell on macOS

Running the Documentation Server

From the repository root, run:

pwsh serve-docs.ps1

Or via MSBuild:

dotnet msbuild -t:ServeDocs

The documentation will be served at http://localhost:4000 with live reload enabled.

Custom Port

To use a different port:

pwsh serve-docs.ps1 -Port 8080

Building Static Documentation

To build the documentation without serving (outputs to _site folder):

dotnet msbuild -t:BuildDocs

Adding New Pages

  1. Create a new .md file in the appropriate docs subfolder
  2. Add front matter at the top of the file:
---
title: Your Page Title
layout: default
nav_enabled: true
nav_order: 110
parent: Parent Section Name
has_toc: false
---
  1. Write your content in Markdown
  2. Preview locally with pwsh serve-docs.ps1

Publishing

Documentation is automatically published to GitHub Pages when changes are merged to the main branch.