@danxbot/ui 15.15.0 → 15.15.1

package/README.md

@@ -101,6 +101,21 @@ Props are plain data and components are addressed by name, so a transcript stays
 serialisable — a component reference in the message would make it impossible to
 persist or replay.
 
+### The library names its own richer alternatives
+
+`COMPONENT_GUIDANCE` (exported from the package root) is a data table, not a
+doc page: for each basic primitive — and each native-HTML/ARIA shape this
+library replaces outright — it names the richer component that usually fits
+better and why (`Textarea` → `InlineMarkdownEdit`/`MarkdownEditor` for prose,
+a `<pre>` → `Markdown`, a ghost text `Button` → `IconButton`, and so on). A
+consuming repo's own source scan reads this table instead of hard-coding the
+same list, so a new richer component added here extends every consumer's
+enforcement with no edit on their side. The rule of thumb it encodes: for
+each piece of data, use the most capable component that fits it, with inline
+editing in place as the default interaction — a plainer primitive is
+sometimes still correct, and that is what a consumer's own escape-hatch
+comment is for, not a reason to leave the table incomplete.
+
 ## Setup
 
 Two stylesheets, and you want both. In your application's Tailwind entry: