Skip to content

Commit

Permalink
feat(docs): add do and dont section (#720)
Browse files Browse the repository at this point in the history
  • Loading branch information
MariaJose authored Feb 17, 2022
1 parent 74f34d0 commit 20524a8
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion packages/docs/pages/panel.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { H1, Panel, Text } from '@bigcommerce/big-design';
import React from 'react';

import { Code, CodePreview, List } from '../components';
import { Code, CodePreview, GuidelinesTable, List } from '../components';
import { MarginPropTable, PanelPropTable } from '../PropTables';

const PanelPage = () => {
Expand Down Expand Up @@ -50,6 +50,25 @@ const PanelPage = () => {
<Panel header="Props" headerId="props">
<PanelPropTable inheritedProps={<MarginPropTable collapsible />} renderPanel={false} />
</Panel>

<Panel header="Do's and Don'ts" headerId="guidelines">
<GuidelinesTable
recommended={[
<>
<Code primary>Panel</Code> should use headings that set clear expectations about the content inside.
</>,
<>
<Code primary>Panel</Code> should prioritize information so the most important content comes first.
</>,
]}
discouraged={[
<>
<Code primary>Panel</Code> should avoid too many call-to-action buttons or links and have only one primary
call to action.
</>,
]}
/>
</Panel>
</>
);
};
Expand Down

0 comments on commit 20524a8

Please sign in to comment.