Skip to main content

Major Segments

As of this writing, this website features three broad segments relying on different technologies

Website

The core of this site is a Docusaurus static documentation site, making use of primarily the docs and blog plugins.

The bulk of the content is written in MDX with occasional use of Mermaid diagrams and other Docusaurus extensions.

Docusaurus provides a customizable navbar and footer that is applicable to all plugins.

Custom UI elements are React (18) components, written in TypeScript.

Custom Components

This site features a small (but growing) number of custom React components to extend the in-built capabilities of Docusaurus

Storybook

A Storybook showcase of the custom components has been integrated with the website and published alongside it here

Storybook stories have also been incorporated into the unit test suite.

Reports

Building the website generates reports, which are shared on the website. Currently generated reports are:

  • Unit tests (pass/fail for individual tests)
  • Unit test coverage