Have you ever struggled with a documentation setup that’s complex and challenging to maintain? This was a pain point for our team while rebooting our design system. We discovered that although our system was built with inclusivity in mind, our documentation setup was equal parts brittle and complex — especially when working with our React-based component library. Multiple repos, rigid layout restrictions, and an impressive amount of gymnastics were needed to render React component examples.
Documentation became a maintenance nightmare for the core team — and a barrier to entry for external contributors. Our team was in danger of having stale documentation while our system’s features were still being built. In this talk, you’ll learn how we streamlined our component library documentation tooling with Gatsby and MDX. Pair this with inclusive best practices, and your component library documentation will be silky smooth.
If you’ve ever struggled with a documentation system that’s tough to maintain, this session is for you.
Kathleen works at O’Reilly Media as the Design System Tech Lead. Her deep industry experience as both a designer and developer fuels her passion for making apps beautifully accessible. In her spare time, she wields a serious Gif game, is the Creative Director for the CrossSisters network, and the best lanterne rouge cyclocrosser you’ll ever meet.