Skip to main content

Contributing to the docs

The docs are plain Markdown in the freemocap.github.io repository, built with Docusaurus. Any text editor works. Every page has an Edit this page link that opens its file on GitHub.

Where pages live​

SectionFolder
Start, tutorials, guides, reference, aboutdocs/
Conceptsconcepts/
Build (developer docs)build-docs/
SkellyCamfetched from the skellycam repo at build time

Make a change​

  1. Fork the repository (outside the FreeMoCap organization) or create a branch (inside it).
  2. Edit the Markdown. To preview, run npm install, npm run fetch, then npm start (Node.js 22 recommended). See Docusaurus Markdown features.
  3. Keep each page's frontmatter current: provenance, plus a history entry with today's date and what you checked the page against.
  4. Open a pull request into main. The build runs on the PR, and a broken internal link fails it.
  5. Once merged, the site updates by itself within a few minutes.

For the Git workflow itself, see Contributing to FreeMoCap.

Moving or renaming a page​

Add the old URL to data/redirects.js so existing links keep working.