Documenting a component

From a component’s panel, the Documentation tab opens whatever has been written about it — and if there is nothing yet, the editor to start.

It is one of two doors: the other is Docs → Library, which lists every entity in the system and tells you which ones are documented and which are not. Both open the same panel and write the same thing.

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 ten 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.