Technical documentation

Run yarn g docs to run the generator for a component documentation page. This generator creates the following files:

  • website/docs/{component}.mdx - container page with Tabs component--"Usage" and "React"
  • website/docs/{component}/usage.mdx - content for "Usage" tab
  • website/docs/{component}/code.mdx - content for "React" tab

Typically, the "Usage" tab will be written by a member of the design team. Look at one of the other components for an example of what to put in the "React" tab.