Skip to main content

Maintainer Overview

The Docusaurus workspace exists to document the plugin, host generated API pages, and keep rule/preset guidance easy to navigate.

Docusaurus slash character getting up and running

Current maintainer prioritiesโ€‹

  1. keep the public preset surface stable
  2. add real Docusaurus-specific rules
  3. keep TypeDoc output and authored docs separate
  4. validate docs builds and links continuously

Current documentation surfaces to keep alignedโ€‹

  • README.md for package-facing installation and rule tables
  • docs/rules/** for authored rule docs and preset guidance
  • docs/docusaurus/site-docs/** for maintainer-facing guides and architecture notes
  • generated API pages under docs/docusaurus/site-docs/developer/api/**

When the rule catalog changes, update the authored docs first, then rerun the sync scripts for the README rules section and preset matrix.

For stronger TypeDoc-specific linting beyond the Docusaurus integration concerns this plugin covers, pair the docs site with eslint-plugin-typedoc.

Architecture snapshotโ€‹

High-level Docusaurus architecture diagram showing plugins, themes, bundling, and runtime outputs