Like Kitten itself, it’s a baby but will be evolving quickly as they approach API version 1 together.
Enjoy!
💕
PS. Of course it’s written in Kitten itself. It doesn’t do anything fancy but here’s the source code if you’re interested: https://codeberg.org/kitten/site
Since I've just been asked again why some of the https://thi.ng/umbrella examples in the repo are not working when copy/pasting the source code into a new (external, I assume) project — there could be several reasons...
The default branch of the repo is develop and usually does contain code which hasn't been released yet (as library/package). If in doubt, please switch to the main branch which contains the state as of the most recent release cycle...
Related to #1, there could be breaking API changes on the develop branch (as is the case for the current major undertaking of thi.ng/geom v8.0.0) and some of the examples are already using the new/upcoming API...
Rare, but possible, I've forgotten to declare dependencies for an example and you might encounter broken imports. Since 2022 I've got a custom tool to verify imports and exports of all packages and examples (and which is run prior to each release), so this shouldn't happen anymore...
Personally, I'm only using a bundler setup/workflow (@vite) and had zero problems in the past few years. However, some people using ESM imports directly have been encountering weird issues with some transpilation features of JS CDNs (e.g. skypack) in the past, but these shouldn't happen with more modern ones like https://esm.run.
Finally, all packages have a generally uniform readme structure, incl. "install/import instructions". For examples, there're also these wiki pages:
Current status: Updating the https://thi.ng/geom readme to give a better overview of the full extensive API, ahead of the v8 release (soon)... Attached are screenshots of three sections of the readme showing:
list of 32 shape types (both 2D and 3D)
list of 54 polymorphic functions/operations to manipulate/convert/analyze shapes & shape hierarchies
list of additional 40 shape creation functions
Still to come: Documenting the bundled preset implementations of:
vertex convolution kernels (3)
curve subdivision strategies (8)
polygon/polyline to bezier conversion strategies (3)
polygon tessellators (9)
(...and how most of these can be combined & applied iteratively. Some of the recent/existing examples are already hinting at the potential...)
I'm investigating options that are available to create a table of contents in #markdown, really wondering what people are using to create that when writing markdown based docs.
With the job market getting tougher by the day, there’s a rising belief among tech writers that their role is “too niche” and a “dead-end job”. I think that’s the wrong way of looking at our profession — at any profession. Let me cast aside that dark veil of pessimism and offer an alternative viewpoint, that of tech writing as a platform to other professions, one that let you move laterally with just a bit of curiosity and courage.
I am fortunate that my manager recognises this critical juncture in technical writing and has given me substantial time to reimagine my job.
I spoke about the benefits of working in the space between professional silos in my Linux Conference talk a few years ago: When STEM Becomes STEAM We All Benefit https://m.youtube.com/watch?v=oEX-F5SxwrU
I really hate haddocks' eyes in code #documentation 'Defines the Foo class', 'Provides an implementation of the foo plugin'. No. It IS the Foo class. It IS the foo plugin.
Why didn't anyone tell me about https://devdocs.io? You convert the site into a web application, enable the packages you need, download for offline access and enjoy fuzzy search, speed and smooth operation for free.
phpDocumentor 3.5 is here! With better Guides support and now fully functional RST! Automatic generated class diagrams by querying your code base and much more!
The series provides an #InDepthAnalysis of the idea that human rights violations, armed conflict & #war cause #psychological & #psychiatric outcomes, using the Kingdom’s tragic past to explore themes.
A young developer who never used Windows 98 back in the day stumbled upon an introductory book on the operating system and posted his impressions on skimming it, which brought him joy. He wrote:
"I was also left with the impression that perhaps I would like more software to come with a physical manual."
Hey if you want to discuss anything about #documentation please sign up at the board at the #DocSummit (room 317) - you can also sign up for lightning talks (documentation related)