Back to Plate

Plugin input rules guide should lead with runtime first then feature owners then API reference

docs/research/decisions/plugin-input-rules-guide-should-lead-with-runtime-first-then-feature-owners-then-api-reference.md

53.0.51.1 KB
Original Source

Plugin input rules guide should lead with runtime first then feature owners then API reference

Question

What documentation structure gives Plate the best DX for the new Plugin Input Rules guide while staying close to Plate's own docs style?

Decision

Use this order:

  1. runtime mental model
  2. quick start
  3. feature-owned rule families
  4. local copied shortcuts
  5. custom rules
  6. execution model
  7. API reference

Why

  • Tiptap proves the concept deserves its own page.
  • Slate proves the teaching flow should be progressive, not reference-first.
  • Lexical proves package wiring should stay explicit and scannable.
  • ProseMirror proves the exact primitive definitions belong in a final reference section, not in the opening.
  • Plate's own style.md and docs-plugin.mdc favor tutorial-first, approachable, example-led documentation.

Consequences

  • The new guide should not read like a renamed API dump.
  • AutoformatKit should appear as one local-copy example, not the conceptual center.
  • Feature pages should link back to the guide for runtime explanations.
  • The final ## API Reference should be the place for exact helper-level details.