Exploring TSDoc & TypeDoc | Typescript Documentation | Live Stream | Webdev

Documentation is hard. Without automation, it's even harder. How can we use Typescript, TSDoc, and TypeDoc to make documentation easy for web development? Adam tries to find out in this (edited) live stream.

00:00 Documentation is hard
03:52 What is Typescript?
04:55 TSDoc is JSDoc without types
09:35 Code, tests, docs... all DRY violations
12:19 Typedoc overview
12:42 Typedoc + ESLint: What's a linter?
15:57 Tools-first development
18:00 Installing TSDoc in VSCode
20:47 Using Typedoc with npx
22:34 Put a Quickstart in your docs
23:22 Typescript project organization
24:45 Exploring Typedoc's default output
35:54 Adding Typedoc content

[mjeivillamin]

Hi butterscotch shenanigans! I just noticed you guys have a community tab! Maybe you can post updates fro games, sneak peeks, or other exclusive photos! I really hope you read this. Anyways, hope you have a wonderful and blessing day! :)

[harshrathod]

This tutorial helped me so much. Thanks.

[jr-hper]

Few of the things I was looking at the typedoc. It does not document the internal function which aren't exported

[forlily]

Thank you for your video
It helped a lot

[javl]

Hi! thanks a lot for this video! I see that by default typedocs checks a index ts file in the project, however i am trying to use it to document some E2E tests that i have built in nightwatch so the structure of the project is a bit different. We don't have an index file, but a number of folders with a bunch of ts files (tests) within them.
Do you know how i can make typedoc read all these ts files inside my directory structure? maybe there is a way to create an index file and reference the other ts files to this so typedoc can process them?

[poolmusicoficial]

Me abria gustado mucho que crashlands fuera online seria muy divertido bro