What does a catalog entry contain?
Every component gets its own entry, which is a page in the catalog. A good entry answers the questions a busy designer asks in the first minute. What is this part? What does it look like? When should I use it? Where is the code? One well-known guide to design system documentation splits these answers into four areas: a description, examples of variants and states, a design reference, and a code reference. A practical entry usually covers six parts.
Live preview
A working demo that people can click and try. A screenshot shows how the part looks, but not how it reacts. Readers prefer interactive demos to static pictures.
Variants and states
Every version of the component and every condition it can be in, such as default, hover, disabled, or loading. Show them together on one page so nobody has to guess what exists.
Props or options
The settings a builder can change, such as a label, a size, or whether the part is turned off. Mark which settings are required and which value is the default.
Do and don't guidance
Short rules for right and wrong use, each with a plain reason. A good entry says when to use the part and when to choose something else instead.
Design and code references
Links to the design file the part came from and to the code that builds it. The designer and the developer then look at the same thing.
Status
A clear label that tells the reader whether the part is stable, in beta, or deprecated. It should appear at the top of the page.
A name and a screenshot are not enough. Entries need depth, or people will use the part in the wrong way. Writing the usage rules and the options takes time, but it prevents costly mistakes later. Accessibility notes also belong in the entry. They tell readers how the part works for people using a keyboard, a screen reader, or other assistive tools.
Status is the entry field that readers check first, so it needs careful wording. A design system team should also decide who owns each entry and how deprecation works, because those rules belong to the system too.
Tip
On a deprecated entry, write the name of the replacement near the top of the page. A reader who lands there should leave knowing what to use instead.