BrandtJul 5, 2025
Karsten Schmidt

Just finished manually updating in total ~780 code blocks & snippets in over 400 files (readme's & source code), adding import statements of all used functions & updating comments over the past week (in addition to the 1st round last weekend[1])... Would be super great to hear if people find this useful/helpful (other than the two who were proposing it in the survey feedback)... 😉

Over the next months I will do another pass over the readmes to make it easier to auto-extract various code examples[2], to try them out and/or test them... Also going forward, new code examples added to readme's will aim to support this feature, but there's a huge backlog of existing ones too.

[1] https://mastodon.thi.ng/@toxi/111997356595048440
[2] https://mastodon.thi.ng/@toxi/111959275083112668

#ThingUmbrella #OpenSource #Documentation #TypeScript #JavaScript

Karsten Schmidt (@[email protected])

Btw. It was also #ReleaseSunday yesterday and as a direct & immediate result from a good criticism received via the community survey, I've updated all 350+ code snippets in 275+ source files/docs of all 190 https://thi.ng/umbrella libraries. Each snippet now includes imports for all functions/constants used, incl. those from other packages (if there are)... The updated docs have also been published on https://docs.thi.ng/. Hope that helps! If you do run into any mistakes & omissions, please get in touch! 🙏 Obviously, this doesn't fix other issues with the docs, but many of them are the result of other fundamental issues with TypeDoc & TypeScript's language server (e.g. treating arrow functions and/or functions annotated with type aliases as 3rd class citizens). I do not have the bandwidth to re-organize a massive project like this around the quirks/bugs of 3rd party infrastructure, but I'm always open to suggestions for how the situ can be improved... Many times I've been pondering and even starting work on a custom doc generator (incl. a ton more metadata, diagrams, cross-references, links to related functions [in other packages]), but I just cannot justify working on this at this stage... #ThingUmbrella #Documentation #OpenSource #TypeScript

Mastodon Glitch Edition
Mar 2, 2024 at 2:26pmWeb
Show threadMatt BacchiMar 2, 2024
@toxi I'll admit I don't use your things (:0) but did look at the examples in bench and imports are helpful. I am extremely put off when a project can't be bothered to include snippets that can be copy/pasted and just work out of the box. So, thanks!
Show threadBrandtJul 5, 2025

@toxi This is good stuff - love it when things just work :)
I've managed to get all of the code snippets for the packages that had them, and the README.md files, so I'm no longer going through browser tabs or directory structures in vscode - I have it all in one place. Thanks, because they really help in my learning experience. BTW - ended up with 377 *.ts files!

I attached image so ppl could see names of the files - it's long. Let me know if you want me to remove the image.