Memfault Docusaurus

Docs are auto-deployed when you commit to main (merge a PR!) If the deploy fails, netlify will roll back to the previous version.

Our docs are built using Docusaurus 2, a static website generator.

Development

Install dependencies:

$ yarn

Start a local webserver that will pick up most changes without restarting:

$ yarn start

Linter

Code is linted with prettier. To fix up files to match format, run:

$ ./node_modules/.bin/prettier --write path/to/file.mdx

Content

Add a new page to the docs:

1. Choose a subdirectory under docs/ and insert your Markdown file. Copy the header from an existing page and give it a unique title and id:.

2. Place any images needed by the page in the matching subdirectory under static/img/docs/.

3. Add the new page to sidebars.js.

Add a new post to the changelog:

1. Create a new post under blog/ using the existing filename conventions. Copy the header from an existing post and give it a nice title.

2. Place any images needed by the post in static/img/blog/.