Documenting a component

From a component’s panel, the Documentation button, in its header beside the close button, opens whatever has been written about it, to read. If there is nothing yet, the panel says No documentation yet and, for admins and editors, offers Edit in Docs.

The panel is for reading, whatever your role. Documentation is written in Docs: the bar at the bottom of the panel has Open in Docs, which opens the component’s page on its Docs tab, and Edit in Docs opens that page already editing.

It is one of two doors, and both lead to the same documentation: the other is Docs itself, where a component’s page has a Docs tab. The panel reads it; Docs is where it is written.

This page used to be the whole catalogue, and it moved

Until 2026-09-09 the entire documentation model lived here: the ten block shapes, how editing works, the permissions. It was a page filed under Components that was barely about components — of its 307 lines, six were about opening this panel.

It moved to the Docs section, which is where someone goes when they want to document something. This URL stays alive so old links do not break.

Where it is now

• ⇢ What can be documented — the eight entities that accept documentation, and what changes between them.
• ⇢ Documentation blocks — the twelve shapes, with examples and when NOT to use each one.
• ⇢ The Docs section — the view that crosses what is synced with what is documented, plus your own pages.