Documenting Code in a Front-End Project

12min Snip

00:00

Play full episode

Summary

Transcript

Episode notes

The speakers discuss different options for documenting code in a front-end project, including README files, comments, structured JS doc, and using tools like Storybook. They highlight the importance of documenting and providing guides for common tasks and emphasize the need to write documentation and notes for every process. They also clarify their intention regarding the Rust programming language and discuss the benefits of learning lower level languages like Rust.

In this episode of Syntax, Wes and Scott answer your questions about Bun, using custom auth headers, the difference between trpc, REST, or GraphQL, documenting your code, why learn Rust, and more!

Show Notes

Take the Syntax Survey

Attend the Syntax Meetup Oct 10th in Toronto

00:00 Syntax Survey
00:24 Syntax Meetup
01:02 Welcome
01:24 Scott’s macOS bug
Tauri Apps
02:19 Syntax Brought to you by Sentry
02:40 What are your thoughts on Bun?
Bun — A fast all-in-one JavaScript runtime
Zig Programming Language
Deno, The next-generation JavaScript runtime
Cloudflare Workers
Netlify Connect
Storybook
Histoire
11:25 How can I add custom auth header for image requests done by the browser?
17:32 What are the differences between trpc, REST, and graphql?
24:48 What kind of teams would use trpc, REST, or graphql?
27:12 Are there any podcast guest opportunities on Syntax?
32:21 With no initial documentation, how do you suggest we document our intricate code, business logic, and integrations?
38:53 Rust didn’t invent this, they’re common paradigms in languages
41:05 Why Rust?
Rust Programming Language
43:52 Is Scott still using his Tonal?
Tonal
44:42 What did I do to make Fetch rebel against me?
Proxyman
50:40 SIIIIICK ××× PIIIICKS ×××