Skip to content

Commit

Permalink
Leverage markdown docs (#1220)
Browse files Browse the repository at this point in the history
* Remove non-functional Renovate badge

* Leverage markdown files in docs

* Update sidebar order
  • Loading branch information
tylersticka authored May 14, 2021
1 parent 8c5b748 commit 8fedd41
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 24 deletions.
4 changes: 3 additions & 1 deletion .storybook/preview.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ export const parameters = {
storySort: {
method: 'alphabetical',
order: [
'Getting Started',
'Introduction',
'Contributing',
'Changelog',
'Design',
'Objects',
'Components',
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Cloud Four Patterns 🚧

[![NPM version](http://img.shields.io/npm/v/@cloudfour/patterns.svg)](https://www.npmjs.org/package/@cloudfour/patterns) [![Build Status](https://github.com/cloudfour/cloudfour.com-patterns/workflows/CI/badge.svg)](https://github.com/cloudfour/cloudfour.com-patterns/actions?query=workflow%3ACI) [![Renovate Status](https://badges.renovateapi.com/github/cloudfour/cloudfour.com-patterns)](https://renovatebot.com/) [![Netlify Status](https://api.netlify.com/api/v1/badges/1923e350-3172-409a-9361-b04d54d1c3b4/deploy-status)](https://app.netlify.com/sites/cloudfour-patterns/deploys?filter=v-next)
[![NPM version](http://img.shields.io/npm/v/@cloudfour/patterns.svg)](https://www.npmjs.org/package/@cloudfour/patterns) [![Build Status](https://github.com/cloudfour/cloudfour.com-patterns/workflows/CI/badge.svg)](https://github.com/cloudfour/cloudfour.com-patterns/actions?query=workflow%3ACI) [![Netlify Status](https://api.netlify.com/api/v1/badges/1923e350-3172-409a-9361-b04d54d1c3b4/deploy-status)](https://app.netlify.com/sites/cloudfour-patterns/deploys?filter=v-next)

🚨 **You are currently viewing the `v-next` branch.** This represents a significant refactor of our environment and coding standards. It is a work in progress and not yet ready for use.

Expand Down
6 changes: 6 additions & 0 deletions src/docs/changelog.stories.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { Meta, Description } from '@storybook/addon-docs/blocks';
import changelog from '../../CHANGELOG.md';

<Meta title="Changelog" />

<Description>{changelog}</Description>
6 changes: 6 additions & 0 deletions src/docs/contributing.stories.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { Meta, Description } from '@storybook/addon-docs/blocks';
import contributing from '../../CONTRIBUTING.md';

<Meta title="Contributing" />

<Description>{contributing}</Description>
18 changes: 18 additions & 0 deletions src/docs/intro.stories.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Meta, Description } from '@storybook/addon-docs/blocks';
import readme from '../../README.md';

<Meta title="Introduction" />

<Description>
{readme
.replace(
'[View Netlify Preview →](https://v-next--cloudfour-patterns.netlify.com/)',
'[View GitHub Repository →](https://github.com/cloudfour/cloudfour.com-patterns)'
)
// Weird link path due to this issue:
// https://github.com/storybookjs/storybook/issues/9005
.replace(
/\[(.+)]\(CONTRIBUTING\.md\)/g,
'<a href="../?path=/story/contributing--page">$1</a>'
)}
</Description>
22 changes: 0 additions & 22 deletions src/welcome.stories.mdx

This file was deleted.

0 comments on commit 8fedd41

Please sign in to comment.