Skip to content

Commit

Permalink
docs: create doc files for components and add an image example
Browse files Browse the repository at this point in the history
  • Loading branch information
tibuurcio committed Oct 7, 2024
1 parent d4f9e30 commit 82619d8
Show file tree
Hide file tree
Showing 10 changed files with 95 additions and 9 deletions.
1 change: 1 addition & 0 deletions .storybook/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const config: StorybookConfig & StorybookVitePlugins = {
name: '@storybook/react-vite',
options: {},
},
staticDirs: [{ from: './public/images', to: 'images' }],

stories: ['../src/**/*.mdx', '../src/**/*.stories.@(ts|tsx)', '../docs/**/*.stories.@(ts|tsx)', '../docs/**/*.mdx'],

Expand Down
Binary file added .storybook/public/images/basic-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/Design Templates/Table/Table.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,7 @@ Table cells that support different formats and are designed to display various
| Type | Resource |
| -------- | ------- |
| Eames | [Figma Templates](https://www.figma.com/design/yCPszaTtkCFxRHaSkkJFR9/Eames-Templates-%5BInternal%5D?node-id=2114-9632&node-type=frame&t=Aa9XxcKyme3ud4cb-0) |

#### Example basic table image (To be changed)

<img src="images/basic-table.png" />
15 changes: 15 additions & 0 deletions docs/components/Data Display/Tag/Documentation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { Meta, Canvas } from '@storybook/blocks';

import * as TagStories from '../../../../src/components/data-display/Tag/Tag.stories';

<Meta of={TagStories} />

{/* Documentation goes here */}

# Tag

This is the documentation for the tags component

{/* Documentation goes here */}

<Canvas meta={TagStories.default} />
15 changes: 15 additions & 0 deletions docs/components/Data Display/Tooltip/Documentation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { Meta, Canvas } from '@storybook/blocks';

import * as TooltipStories from '../../../../src/components/data-display/Tooltip/Tooltip.stories';

<Meta of={TooltipStories} />

{/* Documentation goes here */}

# Tooltip

This is the documentation for the tooltip component

{/* Documentation goes here */}

<Canvas meta={TooltipStories.default} />
15 changes: 15 additions & 0 deletions docs/components/Data Entry/Checkbox/Documentation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { Meta, Canvas } from '@storybook/blocks';

import * as CheckboxStories from '../../../../src/components/data-entry/Checkbox/Checkbox.stories';

<Meta of={CheckboxStories} />

{/* Documentation goes here */}

# Checkbox

This is the documentation for the checkbox component

{/* Documentation goes here */}

<Canvas meta={CheckboxStories.default} />
15 changes: 15 additions & 0 deletions docs/components/Data Entry/Date Picker/Documentation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { Meta, Canvas } from '@storybook/blocks';

import * as DatePickerStories from '../../../../src/components/data-entry/DatePicker/DatePicker.stories';

<Meta of={DatePickerStories} />

{/* Documentation goes here */}

# Date Picker

This is the documentation for the date picker component

{/* Documentation goes here */}

<Canvas meta={DatePickerStories.default} />
15 changes: 15 additions & 0 deletions docs/components/Data Entry/Select/Documentation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { Meta, Canvas } from '@storybook/blocks';

import * as SelectStories from '../../../../src/components/data-entry/Select/Select.stories';

<Meta of={SelectStories} />

{/* Documentation goes here */}

# Select

This is the documentation for the select component

{/* Documentation goes here */}

<Canvas meta={SelectStories.default} />
15 changes: 15 additions & 0 deletions docs/components/Feedback/Modal/Documentation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { Meta, Canvas } from '@storybook/blocks';

import * as ModalStories from '../../../../src/components/feedback/Modal/Modal.stories';

<Meta of={ModalStories} />

{/* Documentation goes here */}

# Modal

This is the documentation for the modal component

{/* Documentation goes here */}

<Canvas meta={ModalStories.default} />
9 changes: 0 additions & 9 deletions docs/components/data-display/Tag/Documentation.mdx

This file was deleted.

0 comments on commit 82619d8

Please sign in to comment.