Skip to content

Latest commit

 

History

History
62 lines (35 loc) · 2.38 KB

doc_template.md

File metadata and controls

62 lines (35 loc) · 2.38 KB

Overview

This section should contain the description and intent of the component. This is generally a combination of the styleguide docs and API docs. Make sure to call out states or anything to look out for in the sections below. Reference the Button component as an example.

Over-arching dev (or design) instructions can live in this section. Depending on the situation, it might be appropriate to add any specific instructions in a separate section below the Overview.

At the end of this section, include a selective group of directly relevant links, as such - See also: Button and Text.

Optional section

Depending on the situation, it might be appropriate to add another section below the Overview to dive deeper into specifics. The title of this section will vary depending on the content that lives here.

Types

(This section contains component examples, ordered by the visual variants of primary, secondary, tertiary, etc. Start with the main visual variant as the primary example.)

Primary

Primary example description goes here.

Followed by the primary example.

Basic Use

(If the component does not contain types (e.g. "primary", "second", "tertiary") or variants, use this header instead.)

Variations

(This section generally pertains to different expressions of the basic component. Not all components will require this section. Reference the Button and Text components.)

Name of variant #1

Variant #1 description goes here.

Followed by the example.

Name of variant #2

(Some variations may require a lengthy description. In these cases it is important to visually break up the information, as shown. This pattern should be used as necessary in any of the sections.)

Title

Description goes here.

Title 2

Description goes here.

Related

(This section always comes at the end of the doc, as shown. This is the full list of related components, as opposed to the most relevant components listed in the overview.)