
Paolo Amoroso
@amoroso@oldbytes.space
Dave Gauer @ratfactor explains why he reads technical books. He expresses very well motivations I share but couldn't articulate, such as books having a single voice and stylistic convention.
@amoroso@oldbytes.space
Dave Gauer @ratfactor explains why he reads technical books. He expresses very well motivations I share but couldn't articulate, such as books having a single voice and stylistic convention.
@amoroso@oldbytes.space
Using LLMs to chat with books and documents? That's so 1978.
In the 1970s the HELPSYS facility of Interlisp-10 let you interrogate the 700+ pages Interlisp Reference Manual via an English like syntax. You could run queries on topics and system functions such as TELL ME ABOUT EVAL
or TELL ME ABOUT THE 2ND ARG OF CHANGEPROP
and HELPSYS would print the relevant information or section of the manual. Here's an example session from the 1978 edition of the manual:
https://www.softwarepreservation.org/projects/LISP/interlisp/Interlisp-Oct_1978.pdf#page=474
Interlisp-10 was the Interlisp implementation for the PDP-10.
@amoroso@oldbytes.space
Using LLMs to chat with books and documents? That's so 1978.
In the 1970s the HELPSYS facility of Interlisp-10 let you interrogate the 700+ pages Interlisp Reference Manual via an English like syntax. You could run queries on topics and system functions such as TELL ME ABOUT EVAL
or TELL ME ABOUT THE 2ND ARG OF CHANGEPROP
and HELPSYS would print the relevant information or section of the manual. Here's an example session from the 1978 edition of the manual:
https://www.softwarepreservation.org/projects/LISP/interlisp/Interlisp-Oct_1978.pdf#page=474
Interlisp-10 was the Interlisp implementation for the PDP-10.
@ioflow@wavelight.ws
my first code contributions to mastodon were accepted and are now online; some small improvements to the user and admin documentation. thanks @andypiper!
@writefreely@writing.exchange
Is anyone using our #WriteFreely Docker image in production? If so, we could use your help with updating our #documentation!
Let me know if you want to contribute, or just feel free to submit a pull request!
https://github.com/writefreely/documentation/blob/main/admin/docker.md
@writefreely@writing.exchange
Is anyone using our #WriteFreely Docker image in production? If so, we could use your help with updating our #documentation!
Let me know if you want to contribute, or just feel free to submit a pull request!
https://github.com/writefreely/documentation/blob/main/admin/docker.md
@writefreely@writing.exchange
Is anyone using our #WriteFreely Docker image in production? If so, we could use your help with updating our #documentation!
Let me know if you want to contribute, or just feel free to submit a pull request!
https://github.com/writefreely/documentation/blob/main/admin/docker.md
@somebitslinks@tech.lgbt
git manpage generator: A parody, something generating plausible but fictional documentation for git
https://git-man-page-generator.lokaltog.net/#bWFzc2FnZSQkYmFyZSByZXBvc2l0b3J5
#documentation #funny #dvcs #unix #git #vcs #+
@somebitslinks@tech.lgbt
git manpage generator: A parody, something generating plausible but fictional documentation for git
https://git-man-page-generator.lokaltog.net/#bWFzc2FnZSQkYmFyZSByZXBvc2l0b3J5
#documentation #funny #dvcs #unix #git #vcs #+
@pandoc@fosstodon.org
The Emacs Org-mode format offers to keep “your life in plain text”. It is a very powerful format with many configuration options.
Pandoc supports a decent subset of Org-mode. Due to the complexity, we maintain an extra page that lists the supported features, how they are translated into pandoc's document model, and explains ways to control and extend the conversion process.
https://pandoc.org/org.html
@toxi@mastodon.thi.ng
A massive shout out and gratitude to @brandtryan for being a superstar and manually reviewing and comparing the expected outputs of the hundreds of code examples & snippets included in the readmes and documentation of the #ThingUmbrella repo. Over the past weeks he submitted dozens of issues with discrepancies, which I now have 99% updated/fixed (I hope)...
Thank you, thank you! 😍
FYI. The snippet extraction system is based on https://thi.ng/tangle, which allows you to extract runnable code examples from code blocks in #Markdown files and from docstrings in source files. More info about this feature & process here:
@kkarhan@infosec.space · Reply to Kevin Karhan :verified:'s post
And yes, whoever uses #discord for #documentation and #versioning instead of a goddam #git [doesn't have to be @github / #GitHub or @gitlab / #GitLab or @Codeberg / #Codeberg or even @gitea / #Gitea - just use any git
and write down your documentation in a useable format like #Markdown or goddamn ASCII plain text FFS] should be banned for life from #coding, working in #IT or contribute to #FLOSS.
@sarah11918@mastodon.social
Astro Docs is redefining Must-See TV... well, for docs 😅
Tomorrow on Talking and Doc'ing:
- Fixing an Astro Docs SEO issue using Starlight's new `routeData`.
- Writing docs for a feature that doesn't exist (and that we don't yet even know how we're going to implement) to drive its development!
Subscribe to the @astro YouTube channel and be notified when we go live (Thurs 9ET / 14:00 CET)
@sarah11918@mastodon.social
Astro Docs is redefining Must-See TV... well, for docs 😅
Tomorrow on Talking and Doc'ing:
- Fixing an Astro Docs SEO issue using Starlight's new `routeData`.
- Writing docs for a feature that doesn't exist (and that we don't yet even know how we're going to implement) to drive its development!
Subscribe to the @astro YouTube channel and be notified when we go live (Thurs 9ET / 14:00 CET)
@janvlug@mastodon.social
Did you ever have a look at the excellent #documentation of #Purism products?
One of the products of Purism is the #Librem5. The Librem 5 is a #Linux phone that runs the #PureOS operating system.
This phone is built up from the bottom to provide #privacy and software #freedom. No #surveillance by the manufacturer, free and #opensource (#FOSS) is their standard.
I use a Librem 5 as my daily phone.
@janvlug@mastodon.social
Did you ever have a look at the excellent #documentation of #Purism products?
One of the products of Purism is the #Librem5. The Librem 5 is a #Linux phone that runs the #PureOS operating system.
This phone is built up from the bottom to provide #privacy and software #freedom. No #surveillance by the manufacturer, free and #opensource (#FOSS) is their standard.
I use a Librem 5 as my daily phone.
@scriptkeepersnetwork@mastodon.social
Meet Tim Brookes: linguist, writer and founder of the Script Keepers Network. His work reminds us that every script tells a story - and some are at risk of being lost forever. So come join our next meeting on July 6th - link in bio.
#endangeredalphabets #linguistics #culturalheritage #scriptrevival #scripts #scriptkeepersnetwork #endangeredscripts #endangeredlanguages #languages #culture #preservation #documentation #indigenous
@scriptkeepersnetwork@mastodon.social
Meet Tim Brookes: linguist, writer and founder of the Script Keepers Network. His work reminds us that every script tells a story - and some are at risk of being lost forever. So come join our next meeting on July 6th - link in bio.
#endangeredalphabets #linguistics #culturalheritage #scriptrevival #scripts #scriptkeepersnetwork #endangeredscripts #endangeredlanguages #languages #culture #preservation #documentation #indigenous
@scriptkeepersnetwork@mastodon.social
A glimpse into Batak manuscripts from North Sumatra! Protecting threatened practices like this is why we do what we do. Join our July 6th meeting - link in bio.
#scripts #scriptkeepersnetwork #endangeredscripts #endangeredlanguages #endangeredalphabets #languages #culture #preservation #documentation #indigenous #indigenouslanguages #indigenousscripts #batak #indonesia #putasha #barkbooks #indigenousknowledge #manuscriptculture #southeastasia #culturalheritage #manuscriptstudies #batakculture
@scriptkeepersnetwork@mastodon.social
A glimpse into Batak manuscripts from North Sumatra! Protecting threatened practices like this is why we do what we do. Join our July 6th meeting - link in bio.
#scripts #scriptkeepersnetwork #endangeredscripts #endangeredlanguages #endangeredalphabets #languages #culture #preservation #documentation #indigenous #indigenouslanguages #indigenousscripts #batak #indonesia #putasha #barkbooks #indigenousknowledge #manuscriptculture #southeastasia #culturalheritage #manuscriptstudies #batakculture
@kevinbowen@hachyderm.io
As a bit of a diversion, I somehow ended up working through the #golang #tutorial this weekend.
I don't remotely consider myself much of a programmer. Possibly, a bit of a code janitor. I was just looking for a bit of an introduction to an unfamiliar language.
I have to say, #Go has some really clear, clean, and helpful #Documentation for a beginner wanting to get started with the language. I'm impressed.
Between the interactive tour(https://go.dev/tour/welcome/1) and the Getting Started tutorial(https://go.dev/doc/tutorial/), I honestly had fun dipping my toes into Go.
Additional resources:
https://gobyexample.com/
@alvinashcraft@hachyderm.io
The Microsoft Docs MCP Server has shipped and provides AI assistants with real-time access to official Microsoft documentation.
Check it out on GitHub here: https://github.com/MicrosoftDocs/mcp
@alvinashcraft@hachyderm.io
The Microsoft Docs MCP Server has shipped and provides AI assistants with real-time access to official Microsoft documentation.
Check it out on GitHub here: https://github.com/MicrosoftDocs/mcp
@cassidy@blaede.family
I find myself once again looking for a good solution to a common problem: as an open source project, hosting documentation/text-based resources as Markdown files in a git repository makes a lot of sense. Buuuut as a collaborative project that wants to invite explicitly less-technical people into the fold, using git and Markdown has a fairly high gatekeeping factor.
How is this not a solved problem? :(
@cassidy@blaede.family
I find myself once again looking for a good solution to a common problem: as an open source project, hosting documentation/text-based resources as Markdown files in a git repository makes a lot of sense. Buuuut as a collaborative project that wants to invite explicitly less-technical people into the fold, using git and Markdown has a fairly high gatekeeping factor.
How is this not a solved problem? :(
@fedify@hollo.social
Did you know? #Fedify provides #documentation optimized for LLMs through the llms.txt standard.
Available endpoints:
Useful for training #AI assistants on #ActivityPub/#fediverse development, building documentation chatbots, or #LLM-powered dev tools.
@fedify@hollo.social
Did you know? #Fedify provides #documentation optimized for LLMs through the llms.txt standard.
Available endpoints:
Useful for training #AI assistants on #ActivityPub/#fediverse development, building documentation chatbots, or #LLM-powered dev tools.
@fedify@hollo.social
Did you know? #Fedify provides #documentation optimized for LLMs through the llms.txt standard.
Available endpoints:
Useful for training #AI assistants on #ActivityPub/#fediverse development, building documentation chatbots, or #LLM-powered dev tools.
@fedify@hollo.social
Did you know? #Fedify provides #documentation optimized for LLMs through the llms.txt standard.
Available endpoints:
Useful for training #AI assistants on #ActivityPub/#fediverse development, building documentation chatbots, or #LLM-powered dev tools.
@fedify@hollo.social
Did you know? #Fedify provides #documentation optimized for LLMs through the llms.txt standard.
Available endpoints:
Useful for training #AI assistants on #ActivityPub/#fediverse development, building documentation chatbots, or #LLM-powered dev tools.
@fedify@hollo.social
Did you know? #Fedify provides #documentation optimized for LLMs through the llms.txt standard.
Available endpoints:
Useful for training #AI assistants on #ActivityPub/#fediverse development, building documentation chatbots, or #LLM-powered dev tools.
@yunohost@toot.aquilenet.fr
#YunoHost: taking care of the ones that would be intimidated by self-hosting
We've just released the new YunoHost documentation engine to make it easier to get started with the solution: https://doc.yunohost.org/
To this end, we're planning to dedicate some time to update and clarify the documentation. Your support is invaluable in animating this process: https://yunohost.org/donate.html
@yunohost@toot.aquilenet.fr
#YunoHost: taking care of the ones that would be intimidated by self-hosting
We've just released the new YunoHost documentation engine to make it easier to get started with the solution: https://doc.yunohost.org/
To this end, we're planning to dedicate some time to update and clarify the documentation. Your support is invaluable in animating this process: https://yunohost.org/donate.html
@toxi@mastodon.thi.ng
Just added some new diagrams to describe the internals of the https://thi.ng/block-fs block storage & filesystem (incl. some examples) and also added/updated CLI tooling docs...
#ThingUmbrella #BlockStorage #FileSystem #TypeScript #JavaScript #Documentation #Diagram
@fcr@post.lurk.org
new & final status update on 'moving image zines rdam':
The complete archive (355 videos) from 2005-2025 has been uploaded & is available on archive.org: https://archive.org/details/moving-image-zines-rdam?sort=-date
All videos are downloadable as high-quality files [mp4/h264 codec, 32 Mbit/s] and reusable under the Creative Commons Attribution-ShareAlike 4.0 International license.
@fcr@post.lurk.org
new & final status update on 'moving image zines rdam':
The complete archive (355 videos) from 2005-2025 has been uploaded & is available on archive.org: https://archive.org/details/moving-image-zines-rdam?sort=-date
All videos are downloadable as high-quality files [mp4/h264 codec, 32 Mbit/s] and reusable under the Creative Commons Attribution-ShareAlike 4.0 International license.
@ben@mastodon.bentasker.co.uk
New #Documentation: Geo-blocking UK users in #BunnyCDN
I've got a site that, I think, #Ofcom _could_ decide falls under Part 5 of the #OnlineSafetyAct (actually, more accurately, I can't say definitively enough that they wouldn't).
I'm not willing to pay any money to the Age Verification industry, or let them have visitor data.
So, I've decided to move the site definitively out of scope by ensuring it doesn't have UK users
The post describes how to geoblock the UK
https://www.bentasker.co.uk/posts/documentation/general/geoblocking-uk-users-with-bunnycdn.html
@ben@mastodon.bentasker.co.uk
New #Documentation: Geo-blocking UK users in #BunnyCDN
I've got a site that, I think, #Ofcom _could_ decide falls under Part 5 of the #OnlineSafetyAct (actually, more accurately, I can't say definitively enough that they wouldn't).
I'm not willing to pay any money to the Age Verification industry, or let them have visitor data.
So, I've decided to move the site definitively out of scope by ensuring it doesn't have UK users
The post describes how to geoblock the UK
https://www.bentasker.co.uk/posts/documentation/general/geoblocking-uk-users-with-bunnycdn.html
@lo48576@mastodon.cardina1.red
HTML 5 に sectioning content や sectioning root という概念があるのにわざわざ適切な h1〜h6 を使うことが “強く推奨” されていることに、また腹が立ってきた (定期的にこの件でブチギレしている) #html5 #documentation
@toxi@mastodon.thi.ng
Latest attempt at building better documentation for https://thi.ng/umbrella (also to make it available offline!): Having noticed that recent versions of TypeDoc support extracting & merging of doc strings from monorepos, over the past few weeks I've been updating/cleaning docstrings in hundreds of source files across all 200+ packages and started building a small tool to assemble a single/mega-page documentation (currently ~4.3MB of just HTML). The tool translates existing docstrings and references contained therein (and still used for the existing API docs) to support proper cross-package references.
I've uploaded an early preview here:
https://docs.thi.ng/umbrella/
Please be aware that so far this is only an early stage prototype and only contains very limited docs. I.e. there are no generics/typeparams, no details about classes/interfaces... But at least I know now HOW to add this all, as well as all the additional metadata I've already got (currently still only available via other custom tools/examples).
For example, there're links to the tag-based browser[1] and I'm also planning to add the fuzzy doc search engine/index[2] to this new documentation... The tag browser integration still needs more work in terms of correctly matching package names to tags. The underlying system is there already, just needs more work in terms of actually doing/assigning the concept mapping. Since most package names in thi.ng/umbrella are very plain/boring (for a reason), for many (most?) packages this already works pretty well:
Example: Visiting the WebGL package docs: https://docs.thi.ng/umbrella/#webgl and then clicking on "examples" for this package, then opens the tag browser for WebGL: https://demo.thi.ng/umbrella/thing-browser/#webgl where you can then see all other packages and examples related to this topic...
More updates on this all soon! Excited! 🤩
(EDIT: added screenshots...)
[1] https://demo.thi.ng/umbrella/thing-browser/
[2] https://demo.thi.ng/umbrella/rdom-search-docs/
#ThingUmbrella #Documentation #Metadata #Tagging #Search #OpenSource #TypeScript #JavaScript
@hywan@fosstodon.org
Want to save electricity?
Want to save bandwidth?
Want to get faster results?
Want to reduce the bills of the Rust foundation?
Use `rustup doc` and browse all the documentation __locally__.
@pythonbynight@fosstodon.org
Alright... finally got some documentation up for my League Manager package up on @readthedocs
Take a look!
@pythonbynight@fosstodon.org
Alright... finally got some documentation up for my League Manager package up on @readthedocs
Take a look!
@plaindocs@chaos.social
Only a couple of weeks left to get your documentation related talk proposal in for the next Write the Docs conference, held May 4-6 Portland.
@plaindocs@chaos.social
Only a couple of weeks left to get your documentation related talk proposal in for the next Write the Docs conference, held May 4-6 Portland.
@amoroso@fosstodon.org
Common Lisp Docs is a Common Lisp documentation project that publishes a quick start guide, a tutorial, a technical reference based on the draft ANSI standard, and more. It's still a work in progress in Beta state.
@amoroso@fosstodon.org
Common Lisp Docs is a Common Lisp documentation project that publishes a quick start guide, a tutorial, a technical reference based on the draft ANSI standard, and more. It's still a work in progress in Beta state.
@LabPlot@floss.social
New #LabPlot User Documentation 📚 🚀
In recent weeks we have been working on transferring LabPlot's documentation to a new format.
The manual still needs to be supplemented with new content, so we encourage everyone to contribute. 🙂
You can find more details in this blog post on LabPlot's website:
➡️ https://labplot.org/2024/12/20/new-labplot-user-documentation
Boosts appreciated! 🙂
#Documentation #Manual #Sphinx #OpenSource #FreeSoftware #FOSS #FLOSS #KDE
@nyamsprod@phpc.social
I am looking for a technical review of my doc to see if everything is understandable. https://github.com/bakame-php/http-structured-fields/tree/master/docs if you want to spend the night ready poetry please feel free to open PR to fix typos or to give advices on how to improve the documentation #php #oss #documentation
@toxi@mastodon.thi.ng
For 12 years already, I've been on/off experimenting (and prototyping) to create a compendium & knowledge graph about computational & generative art, the different movements/genres/mediums (e.g. architecture, design, visual art, audio/music, sculpture, kinetic/motion, film/animation, text etc.), influences, definitions/references, people (artists, curators, writers, thinkers), collectives, organizations (foundations, galleries, museums), exhibitions/festivals, tools & tool makers, common techniques used, art platforms — everything tagged and also supporting to browse by time (centuries & decades, currently starting ~1600) and region...
Attached are some screenshots of my first prototypes from 2011/12 (using #CouchDB, then #neo4j for storage & my own tools for force-directed graph layout) and of the current prototype using #Logseq (https://logseq.com)... The latter is working great for now and feeling, I'm getting somewhere this time, also because I have to make it work (for work!). This is all still just a beginning, hundreds of more people, orgs, projects & references to import and re-check from older versions. The current contents are _very_ biased to my own network/trajectory in/through this space...
Ps. Following up with all the folks & materials I've included already, I'm realizing again and again just how I've been the most naïve and _worst_ person to monetize (mostly not even trying!) my art/contributions... For 20 years I've filed 90% of hundreds of my projects under "experiments", "sketches", "demos", "tutorials" (often also to help illustrate techniques of my open source tools), only to realize (not for the first time) almost everyone else of my old peers has been way less selective and been attaching way more importance to all of their outputs... Maybe one day I will learn, before it's too late...
#KnowledgeGraph #GenerativeArt #Art #Research #Documentation #History
@markwyner@mas.to
Are you a Mastodonian? Do you like finding things with search engines? If so, please read my guide on Mastodon’s search, complete with visuals.
It will help you find your stuff. Find other people’s stuff. Find other people.
Search with intention. Search like a boss. I got you.
New version with updates. Thanks: @stn, @katzentratschen, @DeltaWye, @ClaireFromClare, and @luca.
https://markwrites.io/guide-for-using-mastodon-search
#Mastodon #Fediverse #FediTips #MastodonHelp #MastodonTips #Search #Help #Guide #Documentation
@mmalc@mastodon.social · Reply to Chris Espinosa's post
It must be almost 20 years since I wrote this.
#Documentation
#ObjectiveC
#Swift
#BritishComedy
#Porridge
#EasterEgg
@sarah11918@mastodon.social
It’s 50 days until I turn 50!
So I thought I'd try to motivate myself to add more content to my blog by sharing a different docs tip every day.
Let's see if I can come up with one, small, helpful or interesting daily tidbit inspired by working on @astro docs.
Each one will be a blog post (in part, to remind myself that blog posts can be tiny, too!) and I'll update the main post below with a numbered list as I go.
Stay tuned for a tip later today!
@asmodai@mastodon.social
#introduction 2.0
I'm Jeroen from the Netherlands and a problem solver.
Interests:
#bsd #freebsd #unix
#buddhism #folklore #mythology
#cats
#commodore #c64 #amiga #retrocomputing #hardware
#DevOps
#DigiPres #metadata #SemanticWeb
#documentation #TechnicalWriting
#fantasy #SciFi #books
#history
#heraldry #vexillology
#japanese
#linguistics (#ProtoGermanic #ProtoIndoEuropean)
#programming #assembly #c #golang #nim #odinlang #python #rust #zig
#typography
@mamund@mastodon.social
Poor Documentation Is Costly: Here’s How to Fix It
https://thenewstack.io/poor-documentation-is-costly-heres-how-to-fix-it/
"Investing in documentation can result in fewer wasted hours, more time for essential tasks, and happier employees. ... Let’s discuss how effective documentation — as unexciting as it sounds — can give you a meaningful edge." -- #KnutSveidqvist
@markwyner@mas.to
Are you a Mastodonian? Do you like finding things with search engines? If so, please read my guide on Mastodon’s search, complete with visuals.
It will help you find your stuff. Find other people’s stuff. Find other people.
Search with intention. Search like a boss. I got you.
https://markwyner.medium.com/guide-for-using-mastodon-search-2594cd0e21e2
#Mastodon #Fediverse #FediTips #MastodonHelp #MastodonTips #Search #Help #Guide #Documentation
@bentasker@mastodon.social
I skipped writing an #Introduction whilst getting up and running, but correcting that now.
I'm Ben - I'm a #techie & a #generalist. I'm best at tearing stuff apart to figure out how it works (and by extension how to fix/break it), which leads me down various rabbit holes including #infosec ones.
I write at bentasker.co.uk & have been building a #Documentation archive for a little over a decade, covering #linux, #programming and some other stuff
@ben@mastodon.bentasker.co.uk
Post account move #Introduction
I'm Ben - I was at @bentasker but have now moved to @ben
I'm a #techie and a #generalist. I do best when I'm tearing stuff apart to work out how to fix (or break) it. I occasionally write about #infosec as a result.
I write at bentasker.co.uk about various topics, gradually building up an archive of #documentation covering a range of things, but mostly around #Linux and #software development
@context@fosstodon.org
We often get questions about #documentation. There’s a lot, but not always as up-to-date and as well-structured as we would like...
Most is in the wiki:
https://wiki.contextgarden.net
There’s the “excursion”: https://wiki.contextgarden.net/ConTeXt,_an_excursion
and the “not so short introduction” in several languages:
https://github.com/contextgarden/not-so-short-introduction-to-context
another one in German:
https://github.com/AKielhorn/Context-Intro
and in Chinese:
https://ctan.org/pkg/context-notes-zh-cn
The best place to ask questions is the mailing list:
https://www.ntg.nl/mailman/listinfo/ntg-context
@context@fosstodon.org
Gavin about #documentation for #MetaPost:
I am working with #MetaPost in #ConTeXt. Here are the resources I use, roughly in the order I search when trying to solve a problem.
➤ #MetaFun Manual (http://www.pragma-ade.nl/general/manuals/metafun-p.pdf) This is most comprehensive and helpful source.
➤ MetaPost Manual (http://mirrors.ctan.org/systems/doc/metapost/mpman.pdf) This is not specific to ConTeXt, but it is very useful.
➤ The MetaFun page on the ConTeXt wiki (https://wiki.contextgarden.net/MetaFun_-_MetaPost_in_ConTeXt)
🧵
#LuaTeX #LuaMetaTeX
@lclarke522@gardenstate.social
Greetings! I've been on Mastodon for two years, but I felt the urge for a fresh start. So here I am at gardenstate.social, Jersey Girl that I am. I ❤ NJ, and I have the blog posts to prove it: https://www.lisaclarke.net/tag/beautiful-jersey/
I write #documentation and other content for a tech company for a living, and when I'm not doing that, I'm finding ways to express my creativity. Right now that means #polymerclay and #photography, but other times it's #knitting or #crocheting.
Happy to be here!
#introduction
@toxi@mastodon.thi.ng
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
@polarweasel@hachyderm.io
Looking for my next role as a #documentation manager or lead technical writer.
I’m in British Columbia, Canada. Remote roles only.
Check me out on LinkedIn (https://linkedin.com/in/polarweasel/) and GitHub (https://github.com/polarweasel/)
@ceri@toot.wales
An #introduction, having moved permanently from @ceri@noc.social now.
I work in tech in Wales.
I like #bsd, loved #solaris, worked on both #freebsd and #opensolaris mostly on #documentation
I like #running, being #outdoors, #warhammer and its ilk, #cake and its many friends.
Musically into #shoegaze, #hiphop, #pavement, #sonicyouth and whatever else was out when I was 14-19.
Actively avoid talking about politics but believe it’s important to be kind and look out for others.
Nervous #dysgwr, be kind.
@lo48576@mastodon.cardina1.red
XHTML™ 2.0 - XHTML Structural Module
https://www.w3.org/TR/xhtml2/mod-structural.html#edef_structural_p
<p> がリストや表を持てるのか。うーん
@lo48576@mastodon.cardina1.red
XHTML™ 2.0 - XHTML Caption Module
https://www.w3.org/TR/xhtml2/mod-caption.html#s_captionmodule
ol は caption 要素を持てるのに ul は持たないんだ。言われてみると確かにそれで良さそうではあるが
@lo48576@mastodon.cardina1.red
XHTML™ 2.0 - XHTML Image Module
https://www.w3.org/TR/xhtml2/mod-image.html#s_imagemodule
<img> のメディアが unavailable だった場合に alt text よりも内容のマークアップが使われるのとか、完全に本来あるべき姿でしょ
@lo48576@mastodon.cardina1.red
https://www.w3.org/TR/xhtml2/mod-structural.html#edef_structural_blockcode
<blockcode> とか圧倒的に “正しい” だろ。なーにが <pre><code> じゃ
@lo48576@mastodon.cardina1.red
HTML 5 に sectioning content や sectioning root という概念があるのにわざわざ適切な h1〜h6 を使うことが “強く推奨” されていることに、また腹が立ってきた (定期的にこの件でブチギレしている) #html5 #documentation