React Summit US

React Summit US 2023

A behind the scenes look at the design and development of the all-new React docs at react.dev. The new react.dev launched this year introducing new methodologies like challenges and interactive sandboxes and subtle inclusivity features, like "international tone" and culturally agnostic examples. Not only have the new docs changed how people learn React, they've inspired how we think about developer education as a community. In this talk, you will learn how the React team and some ambitious community members made the "React docs rock" for a generation of front end developers and how these new patterns and established techniques can be applied in your favorite projects.

Gateway to React: The React.dev Story

Rachel Nabors

JS Nation

JSNation 2022

Interactive web-based tutorials have become a staple of front end frameworks, and it's easy to see why — developers love being able to try out new tools without the hassle of installing packages or cloning repos.But in the age of full stack meta-frameworks like Next, Remix and SvelteKit, these tutorials only go so far. In this talk, we'll look at how we on the Svelte team are using cutting edge web technology to rethink how we teach each other the tools of our trade.

Full Stack Documentation

Rich Harris

React Finland

React Finland 2021

Documentation is often your community's first point of contact with your project and their daily companion at work. So why is documentation the last thing that gets done, and how can we do it better? This talk shares how important documentation is for React and React Native and how you can invest in or contribute to making your favourite project's docs to build a thriving community <a href="https://www.froala.com/wysiwyg-editor?pb=1"> </a>

Opensource Documentation—Tales from React and React Native

We'll walk through what it takes to build a Node.js runtime for the browser, the challenges we discovered along the way and solutions we built to those challenges.

Building a Node.js Runtime for the Browser

Jasper De Moor

React Advanced

React Advanced Conference 2023

Gathering pieces of information for a task or a project is a wasteful act and could result in duplicated work done by different people.Onboarding, your ability to maintain code or infrastructure and systems handover - Documentation plays a crucial part in all these processes.So... how can we write technical docs in an easy way &amp; why should we even do it? In this talk, I’ll show you a structured way to write technical docs, without being a technical writer - So you will deliver highly valuable information to your audience, to your best ability.I’ll explain why should you care about these docs, how do they serve your best interests (Yes, there’s more than one!) and what a wide impact it could make on employees and even on your entire organization.

Technical Documentation - How Can I Write Them Better and Why Should I Care?

Hila Fish

TS Congress

TypeScript Congress 2022

Using real-life open-source examples, we'll explore the power of TypeScript to improve your users' experience. We'll cover best practices for library authors, as well as tips and tricks for how to take a library to the next level. This talk will cover:  - how to leverage the type inference to provide help to your users; - using types to reduce the need and complexity of your documentation - for example, using function overloads, string literal types, and helper (no-op) functions; - setting up testing to ensure your library works (and your types do too!) with tools like tsd and expect-type; - treating types as an API and reducing breaking changes whilst shipping enhancements; - I'd draw on my experience with libraries like nuxt3, sanity-typed-queries and typed-vuex and show what we managed to do and what I'd do differently in future.

TypeScript for Library Authors: Harnessing the Power of TypeScript for DX

Daniel Roe

React Advanced Conference 2021

"In Space, No One Can Hear You Scream." The same goes for your super-brand-new-revolutionary project: Documentation is the key to get people speaking about it.Building well-fitted documentation can be tricky. Having it updated each time you release a new feature had to be a challenging part of your adventure. We tried many things to prevent the gap between doc and code: code-generated documentation, live examples a-la-Storybook, REPL...It's time for a new era of documentation where people-oriented content lives along with code examples: this talk will guide you from Documentation Best Practices – covered from years of FOSS collaborative documentation – to the new fancy world of Components in Markdown: MDX, MDJS, MD Vite, and all.Let's build shiny documentation for brilliant people! <a href="https://www.froala.com/wysiwyg-editor?pb=1"> </a>

The Legendary Fountain of Truth: Componentize Your Documentation!

m4dz 

Your Second Source of Truth

I'll present a practical approach to styling react components, a folder structure and documentation structure that's very easy to follow (for onboarding members) + other insights I got while using this approach. <a href="https://www.froala.com/wysiwyg-editor?pb=1"> </a>

How to structure, style and document your components for maximum effectiveness

Dragos Bilaniuc

Most documentation systems focus on text content of one form or another: WYSIWYG editors, markdown, code comments, and so forth. Storybook, the industry-standard component workshop, takes a very different approach, focusing instead on component examples, or stories. In this demo, I will introduce an open format called Component Story Format (CSF). I will show how CSF can be used used to create interactive docs in Storybook, including auto-generated DocsPage and freeform MDX documentation. Storybook Docs is a convenient way to build a living production design system. I will then show how CSF stories can be used create novel forms of documentation, such as multiplayer collaborative docs, interactive design prototypes, and even behavioral documentation via tests. Finally, I will present the current status and outline a roadmap of improvements that are on their way in the coming months. <a href="https://www.froala.com/wysiwyg-editor?pb=1"> </a>

Documenting components with stories

Michael Shilman

In this talk, Patrick goes through the effort that went into ReScript's documentation platform. You can check the slides for this talk <a href="https://drive.google.com/file/d/1Nc9m2BpEvzcgUBhDFn48e5xGMQN8iGmm/view" target="_blank">here</a>. <a href="https://www.froala.com/wysiwyg-editor?pb=1"> </a>

The Story of ReScript's Documentation Platform

Patrick Ecker

React Summit

React Summit 2020

Is your complex documentation setup a maintenance nightmare and chasing away potential contributors? In this talk, you will learn how to make your React component library documentation more user and contributor-friendly with Gats and MDX. Pair this with accessibility best practices, and your documentation will be inclusively smooth. <a href="https://www.froala.com/wysiwyg-editor?pb=1"> </a>

#documentation