2024.01.29 - API Documentation 101

Title: 2024.01.29 – API Documentation 101

Zed & Flow while coding & 脱发 & 制心于一处

This Week’s Highlights

API Documentation 101: Everything You Need to Get Started https://blog.readme.com/api-documentation-101-everything-you-need-to-get-started/
Whether you’re learning the ropes for the first time, looking for a refresher, or want to improve your existing API docs, we’ll walk you through what API documentation actually is, why good docs matter, and share our best practices and tips along the way.

Zed – Code at the Speed of Thought https://github.com/zed-industries/zed
Welcome to Zed, a high‑performance, multiplayer code editor from the creators of Atom and Tree‑sitter.

The Bun Shell https://bun.sh/blog/the-bun-shell
JavaScript is the world’s most popular scripting language. So why is it hard to run shell scripts in JavaScript?

How to Get in the Flow While Coding (and Why It’s Important) https://github.blog/2024-01-22-how-to-get-in-the-flow-while-coding-and-why-its-important/
Explore what flow state entails, its benefits, and three tips for reaching it the next time you code. Related: How GitHub’s Developer Experience team improved inner‑loop development.

Computing Education in the Era of Generative AI https://cacm.acm.org/magazines/2024/2/279537-computing-education-in-the-era-of-generative-ai/fulltext
This article discusses the challenges and opportunities generative models present to computing educators, focusing on introductory programming classrooms. The discussion is organized around two foundational papers from the computing‑education literature written when awareness of code‑generating language models was just emerging.

OpenAI: New embedding models and API updates
Technical Perspective: Bridging AI with Real‑Time Systems
10 Unexpected Ways to Use GitHub Copilot
Build a Large Language Model (From Scratch)
Chrome Is Getting 3 New Generative AI Features
How It’s Made – Exploring AI × Learning Through ShiffBot, an AI Experiment Powered by the Gemini API
The Path to Socially Responsible AI

In‑Depth Reading

HTTP at Thirty‑Three https://www.simplethread.com/http-at-thirty-three/
I am of the opinion that the Hypertext Transfer Protocol is a marvel. Its earliest version could not be simpler: it only describes the most basic GET request, and yet GET remains the workhorse of the web thirty‑three years later.

Removing React Is Just Weakness Leaving Your Codebase https://begin.com/blog/posts/2024-01-26-removing-react-is-just-weakness-leaving-your-codebase
It’s 2024, and you’re about to start a new project. Do you reach for React, a framework you know and love, or do you look at one of the other hot new frameworks like Astro, Enhance, 11ty, SvelteKit, or—gasp—plain‑vanilla Web Components? In this post I’ll enumerate why I stopped using React two years ago after seven years of wrestling with the library.

Web Components in Earnest https://naildrivin5.com/blog/2024/01/24/web-components-in-earnest.html
I’ve previously written about a basic experience with Web Components and not getting it, but I think I get it now. In this (quite long) post I’ll go over how I built Ghola, a palette generator for developers. It’s entirely built with custom elements, has almost no dependencies, runs fast, and was fun to work on.

12 Modern CSS One‑Line Upgrades https://moderncss.dev/12-modern-css-one-line-upgrades/
Sometimes improving your app’s CSS is just a one‑line upgrade or enhancement! Learn about 12 properties to start incorporating into your projects, and enjoy reduced technical debt, less JavaScript, and easy wins for user experience. Related: Big, beautiful, beefy focus states with :focus-visible.

Only 90s Web Developers Remember This https://zachholman.com/posts/only-90s-developers/
You were a web developer in the 1990s. With that status, you knew you were hot stuff. And you brought with you a slew of fearsome technological innovations that we haven’t come close to replicating since. Related: The indieweb is for everyone.

Rust vs Go in 2024 https://bitfieldconsulting.com/golang/rust-vs-go
Which is better, Rust or Go? Which language should you choose for your next project, and why? How do the two compare in performance, simplicity, safety, features, scalability, and concurrency? What do they share, and where do they fundamentally differ? Let’s find out in this friendly, even‑handed comparison.

Fresh Finds

Deno 1.40: Temporal API
Progress of the Flutter and Dart Package Ecosystem
TypeSpec: Describe your data up front and generate schemas, API specifications, client/server code, docs, and more.
Typist: The mighty Tiptap‑based rich‑text editor that powers Doist products.
Announcing AdonisJS v6: The Node.js framework highly focused on developer ergonomics, stability, and confidence
Shiki: A beautiful yet powerful syntax highlighter
Jint: JavaScript interpreter for .NET
Wiki.js: The most powerful and extensible open‑source wiki software

Products & Others

A Few Truths You Should Know About Fever, Cough, and Allergies https://mp.weixin.qq.com/s/xrERbXNkxgS2nSCm9jWynA
When a child has a fever, many parents’ first reaction is “give the kid something to reduce the fever.” However, from a Traditional Chinese Medicine perspective, fever isn’t necessarily a bad thing. Why? First, we need to understand the principle behind fever. Knowing the mechanism is important because different understandings lead to different choices, and different choices lead to different outcomes.

Hair Loss: The Body’s Way of Saying We Don’t Need Hair https://mp.weixin.qq.com/s/-HcuuWTWAQqqUPUraf5_aw
Baldness has plagued humanity for ages. Whether you try ginger, He Shou Wu (a traditional herb), or hair‑growth serums, you may still end up with only a few stray strands. In fact, treating hair loss can be portrayed as either extremely difficult or surprisingly easy.

When Warm‑Disease Season Arrives Early in Spring, Brew a Pot of Old Soup to “Store Yin Energy” https://mp.weixin.qq.com/s/sKrvSCbEuntyIdTPcpgMNQ
“Fail to store essence in winter, and you’ll fall ill with warm diseases in spring.” Yet the winter of 2022 was dominated by COVID‑19, and the winter of 2023 was a “warm winter” where people didn’t really store anything. So we’ve effectively missed two consecutive winters of proper “winter storage.” In this context, the “warm disease” expected in the spring of the Jiǎ‑chén year (2024) warrants extra vigilance.

Viewing Circular Motion Through the Lens of the Five Elements https://mp.weixin.qq.com/s/2lxMMNzCV3pkJpmEqcblqA
The Five Elements originally stem from a single qi; they represent different states of the yin‑yang circular motion. In the heavens the Five Elements manifest, on earth they correspond to the five zang (viscera). Because heaven and humanity correspond, the Five Elements pair with the five zang.

集中于一处 https://mp.weixin.qq.com/s/PpPFwuu-cLFRfoYxCj0

(content truncated)

---

Originally written by Ping Xia (平侠) and published in Chinese on Web技术周刊 (Web Tech Weekly). Translated and adapted for DriftSeas with permission.