Skip to content

Commit

Permalink
docs: setup for docs war room
Browse files Browse the repository at this point in the history
  • Loading branch information
tibuurcio committed Dec 18, 2024
1 parent 3883996 commit c0e3048
Show file tree
Hide file tree
Showing 24 changed files with 124 additions and 79 deletions.
18 changes: 2 additions & 16 deletions .storybook/preview.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,9 @@ const preview: Preview = {
storySort: {
order: [
'About',
[
'Introduction',
'Changelog',
'FAQ',
'Feedback',
'Component Process',
[
'Introduction',
'Components',
['Using components', 'Change process'],
'Candidate Components',
['Introducing new ones', 'Using existing ones', 'Promoting to a component'],
'Design Templates',
],
],
['Introduction', 'Changelog', 'Feedback', 'Component Process'],
'Foundations',
['Colors', 'Typography', 'Icons', 'Errors', 'Loading'],
['Typography', 'Icons', 'Color Palette'],
'Components',
[
'Data Display',
Expand Down
7 changes: 7 additions & 0 deletions docs/About/Component Process.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Component Process

We have a process around introducing new components into the library. This process is designed to ensure that the components we add are well-designed,
well-documented, and well-tested. See the link above to understand more about it.

[Component Process Figjam](https://www.figma.com/board/jRyvM0L4fWa8j1NmE5tZ7y/Component-Process)
[Component Library & Custom Component Process](https://docs.google.com/document/d/1VvnaEzl_IBSMBMmPdGMnkX1FScQWBs5D8QYY2NuS9GI/edit?tab=t.0#heading=h.2z05vt46ooti)

This file was deleted.

This file was deleted.

This file was deleted.

3 changes: 0 additions & 3 deletions docs/About/Component Process/Components/Change process.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions docs/About/Component Process/Components/Using components.mdx

This file was deleted.

This file was deleted.

3 changes: 0 additions & 3 deletions docs/About/Component Process/Introduction.mdx

This file was deleted.

6 changes: 0 additions & 6 deletions docs/About/FAQ.mdx

This file was deleted.

4 changes: 1 addition & 3 deletions docs/About/Feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,4 @@

We’re constantly working to improve our UI Library, and your feedback is invaluable in making it better. Whether you’ve encountered an issue, have suggestions for new components, or just want to share your experience, we’d love to hear from you!

To provide feedback, simply click the link below to access our feedback form or drop your thoughts directly in the `#Aquarium` channel on Slack. We review all submissions carefully and appreciate your time!

[Submit Feedback](https://docs.google.com/forms/d/e/1FAIpQLScF_uUFfATYR64z-toPMkPrHvbmDE_mzYQyQ9M-QJjrZTQ68Q/viewform?usp=sf_link)
To provide feedback, drop your thoughts directly in the `#aquarium` channel on Slack. We review all submissions carefully and appreciate your time!
24 changes: 8 additions & 16 deletions docs/About/Introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
# Introduction
# Introduction - mParticle UI Library

This is where all component related documentation will live at mParticle. This is mainly a work in progress at this point
and we are actively working on it.
Designed for developers, designers, and product managers, this library makes it easy to create intuitive, interactive interfaces for **mParticle applications**.

## How to read this
## Key Features

TBD
- **Foundations:** Design elements like colors, typography, spacing, and icons.
- **Components:** Ant Design-based, scalable, and ready to use.
- **Pattern Library:** The system we rely on to build the **mParticle application**.
- **Interactive Examples:** Practical demos to help you get started quickly.

## Glossary

| Term | Meaning |
| -------- | ------- |
| Component Candidate | TBD |
| Template | TBD |
| Eames | TBD |
| Aquarium | TBD |
| Antd | TBD |

---
Simple, flexible, and reliable—this library helps you focus on building great experiences without worrying about the basics.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions docs/components/Navigation/Anchor/Documentation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { Meta, Canvas } from '@storybook/blocks'

import * as AnchorStories from '../../../../src/components/navigation/Anchor/Anchor.stories'

<Meta of={AnchorStories} />

{/* Documentation goes here */}

# Anchor

This is the documentation for the Anchor component

{/* Documentation goes here */}

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

import * as BreadcrumbStories from '../../../../src/components/navigation/Breadcrumb/Breadcrumb.stories'

<Meta of={BreadcrumbStories} />

{/* Documentation goes here */}

# Breadcrumb

This is the documentation for the Breadcrumb component

{/* Documentation goes here */}

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

import * as DropdownStories from '../../../../src/components/navigation/Dropdown/Dropdown.stories'

<Meta of={DropdownStories} />

{/* Documentation goes here */}

# Dropdown

This is the documentation for the Dropdown component

{/* Documentation goes here */}

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

import * as GlobalNavigationStories from '../../../../src/components/navigation/GlobalNavigation/GlobalNavigation.stories'

<Meta of={GlobalNavigationStories} />

{/* Documentation goes here */}

# GlobalNavigation

This is the documentation for the GlobalNavigation component

{/* Documentation goes here */}

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

import * as MenuStories from '../../../../src/components/navigation/Menu/Menu.stories'

<Meta of={MenuStories} />

{/* Documentation goes here */}

# Menu

This is the documentation for the Menu component

{/* Documentation goes here */}

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

import * as PaginationStories from '../../../../src/components/navigation/Pagination/Pagination.stories'

<Meta of={PaginationStories} />

{/* Documentation goes here */}

# Pagination

This is the documentation for the Pagination component

{/* Documentation goes here */}

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

import * as StepsStories from '../../../../src/components/navigation/Steps/Steps.stories'

<Meta of={StepsStories} />

{/* Documentation goes here */}

# Steps

This is the documentation for the Steps component

{/* Documentation goes here */}

<Canvas meta={StepsStories.default} />
2 changes: 1 addition & 1 deletion src/components/navigation/Dropdown/Dropdown.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ type Story = StoryObj<typeof Dropdown>
*/

export const Primary: Story = {
tags: ['deprecated'],
// tags: ['deprecated'],
}

export const WithArrow: Story = {
Expand Down

0 comments on commit c0e3048

Please sign in to comment.