carbon-design-system / carbon-platform

The "next" version of the Carbon Design System website, as a platform.
https://next.carbondesignsystem.com
Apache License 2.0
21 stars 5 forks source link

Put MDX Common Errors Page inside packages/mdx-component 's SB #1430

Open francinelucca opened 1 year ago

francinelucca commented 1 year ago

Related #1123 Once #1423 is complete, migrate mdx common errors page into SB docs

francinelucca commented 1 year ago
import InlineError from '@/components/inline-error/inline-error'
import H2 from '@/components/markdown/h2'
import H3 from '@/components/markdown/h3'
import { UL } from '@/components/markdown/index'
import LI from '@/components/markdown/li'
import P from '@/components/markdown/p'
import FullPageError from '@/components/mdx-page/errors/full-page-error/full-page-error'
import PageDescription from '@/components/page-description/page-description'
import PageHeader from '@/components/page-header/page-header'
import { assetsNavData } from '@/data/nav-data'
import { LayoutContext } from '@/layouts/layout'

These are all the local imports in that file, do we expect all these components to be migrated? How will we handle LayoutContext and assetsNavData? 🤔
@alisonjoseph @jdharvey-ibm

jharvey10 commented 1 year ago

@francinelucca Since this page will be part of storybook, can we forego the assetsNavData and LayoutContext? The "side nav" will effectively be the storybook side bar. For the error condition components, we could include those in the mdx-components package as well in their own section in storybook. That's kind of a neat way to publicize the patterns we're using for these types of errors as well.

francinelucca commented 1 year ago

@jdharvey-ibm no problem from me with going without sidenav, was just going off of the design specs which has it 🤔

jharvey10 commented 1 year ago

Related: Currently, when you click a link that takes you to the common errors page, it doesn't open in a new tab. It probably should. It's an out-of-band experience from the Platform website which you'd probably want to view "in addition to" and not "instead of" the Platform page you were on.

@carbon-design-system/carbon-platform-designers does that change make sense to all of you?

Example page

jharvey10 commented 1 year ago

Hey team! Please add your planning poker estimate with Zenhub @andreancardona @francinelucca