/memfault-docs

Memfault Docs

Primary LanguageJavaScript

Netlify Status Gitpod ready-to-code

Memfault Docusaurus

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

static/img/memfault-docusaurus.png

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

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 thte post in static/img/blog/.