JSDoc VS storybook

I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead.

[1] https://jsdoc.app/

This is where JSDoc comes to save the day.

The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:

There is a lot of specific symbols presented on the JSDOC specification that can be found here: https://jsdoc.app

JSDoc is a specification for the comment format in JavaScript. This specification allows developers to describe the structure of their code, data types, function parameters, and much more using special comments. These comments can then be transformed into documentation using appropriate tools.

Working with new features, frameworks, and tools, the experience of reading documentation is a critical part of it. I have been lucky to work with projects that feature really easy to read documentation such as USWDS and Bun, but I've also had the misfortune to work with pretty terrible documentation like JSDoc. The JSDoc documentation lacks a search field which makes searching for specific items an ordeal and also does not cover many hidden use cases. It provides less than the bare minimum for what it needs to do - a lot of the time I am forced to rely on external user documentation elsewhere to use JSDoc effectively. That was why I was drawn to the search field in particular in Docusaurus.

The Svelte team followed suit but motivated by the maintainer's developer experience as they migrated the project away from TypeScript in favor of plain JSDoc comments for type annotations instead.

Even more relevant, tools like Javadoc, JSDoc, Doxygen, etc. read comments in a specific format to generate documentation. These comments do not affect readability. On the contrary, Javadocs are great for explaining how to use these entities. Combined with tools like my dear Doctest, we even get guarantees of accuracy and correctness!

Document types with JSDoc annotations

📚 JSDoc for documentation and jsdoc-to-markdown to create docs as markdown files

[Bug]: Configuration with TailwindCss Next.js using Tailwind with Storybook

Astro has no runtime. This means no unit tests. This also means no Storybook for your Astro components (although, they’re working on it!)

If you're into UI development, then you need to know about Storybook. It's a frontend workshop for building UI components and pages in isolation. The latest version brings some big improvements for testing and documentation with built-in visual testing. There's also React Server Component support, improved controls for React and Vue projects, as well as improved Vite architecture, Vitest testing, and Vite 5 support. Check out all the major changes in the Storybook changelog.

Storybook

We are continuing to make building fullstack websites and application with Analog and Angular as seamless as possible, and extending the Angular ecosystem through integrations with Astro, Nx, [Vitest]https://analogjs.org/docs/features/testing/vitest, Storybook, and more.

Storybook is the industry standard UI tool for building, testing, and documenting components and pages. It’s used by thousands of teams globally, integrates with all major JavaScript frameworks, and combines with most leading design and developer tools.

Expo has first-class support for building full-stack websites with React, so I can leverage that to add Cypress/Playwright for E2E testing and add the Storybook for UI components.

Storybook emerges as a pioneering solution among React debugging tools, offering an interactive environment for developers to create and test UI components. With its robust platform, teams can build, organize, and design UI components, and even entire screens, without the hurdles of business logic and plumbing.

3) Look into things like StoryBook for your components - https://storybook.js.org/ - they help you get into good practices and expose you to some more advanced techniques but in a gradual and friendly way, and again, it's good to get into good habits from the start, and these help make sure you're getting into those good habits (it can be hard to learn good habits, but being forced into them helps, I find!)

[Storybook 7.6](https://github.com/storybookjs/storybook/releases) is here with increased performance and much more! 🔥 Improved SWC support 🧪 New test utilities and fast build mode 🔼 NextJS SWC + avif support & fixes 🤡 SvelteKit page and navigation mocking ⚛️ React-docgen upgrade 🎨 Controls a11y, background theming, and viewports 🩺 CLI: The doctor is in! 🚫 Addons: Remove React as a peer dependency 🪦 Storyshots and Vue2 deprecated