Skip to main content

ADR-0002: Two-docs-plugin sidebar model

  • Status: Accepted
  • Date: 2026-04-04

Contextโ€‹

The project has two distinct documentation audiences:

  1. Rule consumers (/docs/rules/**)
  2. Plugin contributors (/docs/developer/**)

Decisionโ€‹

Use two docs plugin instances:

  • classic docs plugin for developer-focused docs
  • dedicated rules docs plugin for rules/presets/guides

Keep separate sidebar sources to maintain audience-focused navigation.

Consequencesโ€‹

Positiveโ€‹

  • Clearer navigation per audience
  • Cleaner sidebar information density
  • Less cross-context sidebar confusion

Trade-offsโ€‹

  • Route/link updates must be synchronized across plugin boundaries
  • Navbar/footer links require extra care when moving docs pages