#documentation

Fedify: an ActivityPub server framework's avatar
Fedify: an ActivityPub server framework

@fedify@hollo.social

Did you know? provides optimized for LLMs through the llms.txt standard.

Available endpoints:

Useful for training assistants on / development, building documentation chatbots, or -powered dev tools.

Fedify: an ActivityPub server framework's avatar
Fedify: an ActivityPub server framework

@fedify@hollo.social

Did you know? provides optimized for LLMs through the llms.txt standard.

Available endpoints:

Useful for training assistants on / development, building documentation chatbots, or -powered dev tools.

Fedify: an ActivityPub server framework's avatar
Fedify: an ActivityPub server framework

@fedify@hollo.social

Did you know? provides optimized for LLMs through the llms.txt standard.

Available endpoints:

Useful for training assistants on / development, building documentation chatbots, or -powered dev tools.

Fedify: an ActivityPub server framework's avatar
Fedify: an ActivityPub server framework

@fedify@hollo.social

Did you know? provides optimized for LLMs through the llms.txt standard.

Available endpoints:

Useful for training assistants on / development, building documentation chatbots, or -powered dev tools.

Fedify: an ActivityPub server framework's avatar
Fedify: an ActivityPub server framework

@fedify@hollo.social

Did you know? provides optimized for LLMs through the llms.txt standard.

Available endpoints:

Useful for training assistants on / development, building documentation chatbots, or -powered dev tools.

YunoHost's avatar
YunoHost

@yunohost@toot.aquilenet.fr

: taking care of the ones that would be intimidated by self-hosting

:yunohost: We've just released the new YunoHost documentation engine to make it easier to get started with the solution: doc.yunohost.org/

:neopossum_laptop: To this end, we're planning to dedicate some time to update and clarify the documentation. Your support is invaluable in animating this process: yunohost.org/donate.html

YunoHost's avatar
YunoHost

@yunohost@toot.aquilenet.fr

: taking care of the ones that would be intimidated by self-hosting

:yunohost: We've just released the new YunoHost documentation engine to make it easier to get started with the solution: doc.yunohost.org/

:neopossum_laptop: To this end, we're planning to dedicate some time to update and clarify the documentation. Your support is invaluable in animating this process: yunohost.org/donate.html

Karsten Schmidt's avatar
Karsten Schmidt

@toxi@mastodon.thi.ng

Just added some new diagrams to describe the internals of the thi.ng/block-fs block storage & filesystem (incl. some examples) and also added/updated CLI tooling docs...

Screenshot excerpt of the https://thi.ng/block-fs readme, showing the section & diagrams about file system data layouts and internals.
ALT text detailsScreenshot excerpt of the https://thi.ng/block-fs readme, showing the section & diagrams about file system data layouts and internals.
Screenshot excerpt of the https://thi.ng/block-fs readme, showing the section about the command line tool (incl. terminal output). The first example shows how to convert a file tree from the host system into a single binary blob, the second command example shows how to list files/directories from such a blob
ALT text detailsScreenshot excerpt of the https://thi.ng/block-fs readme, showing the section about the command line tool (incl. terminal output). The first example shows how to convert a file tree from the host system into a single binary blob, the second command example shows how to list files/directories from such a blob
fcr's avatar
fcr

@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: archive.org/details/moving-ima

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's avatar
fcr

@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: archive.org/details/moving-ima

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 Tasker's avatar
Ben Tasker

@ben@mastodon.bentasker.co.uk

New : Geo-blocking UK users in

I've got a site that, I think, _could_ decide falls under Part 5 of the (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

bentasker.co.uk/posts/document

Ben Tasker's avatar
Ben Tasker

@ben@mastodon.bentasker.co.uk

New : Geo-blocking UK users in

I've got a site that, I think, _could_ decide falls under Part 5 of the (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

bentasker.co.uk/posts/document

らりお・ザ・何らかの🈗然㊌ソムリエ's avatar
らりお・ザ・何らかの🈗然㊌ソムリエ

@lo48576@mastodon.cardina1.red

HTML 5 に sectioning content や sectioning root という概念があるのにわざわざ適切な h1〜h6 を使うことが “強く推奨” されていることに、また腹が立ってきた (定期的にこの件でブチギレしている)

Karsten Schmidt's avatar
Karsten Schmidt

@toxi@mastodon.thi.ng

Latest attempt at building better documentation for 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:
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: docs.thi.ng/umbrella/#webgl and then clicking on "examples" for this package, then opens the tag browser for WebGL: demo.thi.ng/umbrella/thing-bro 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] demo.thi.ng/umbrella/thing-bro
[2] demo.thi.ng/umbrella/rdom-sear

Screenshot of the documentation tool/page mentioned in the post, showing the API docs for this function (dark color scheme): https://docs.thi.ng/umbrella/#fuzzy-viz:instrumentStrategy
ALT text detailsScreenshot of the documentation tool/page mentioned in the post, showing the API docs for this function (dark color scheme): https://docs.thi.ng/umbrella/#fuzzy-viz:instrumentStrategy
Screenshot of the documentation tool/page mentioned in the post, showing the API docs for this function (light color scheme): https://docs.thi.ng/umbrella/#fuzzy-viz:instrumentStrategy
ALT text detailsScreenshot of the documentation tool/page mentioned in the post, showing the API docs for this function (light color scheme): https://docs.thi.ng/umbrella/#fuzzy-viz:instrumentStrategy
Ivan Enderlin 🦀's avatar
Ivan Enderlin 🦀

@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__.

rustup.rs/

Mario Munoz's avatar
Mario Munoz

@pythonbynight@fosstodon.org

Alright... finally got some documentation up for my League Manager package up on @readthedocs

Take a look!

leaguemanager.readthedocs.io/e

Mario Munoz's avatar
Mario Munoz

@pythonbynight@fosstodon.org

Alright... finally got some documentation up for my League Manager package up on @readthedocs

Take a look!

leaguemanager.readthedocs.io/e

DJ Fragile Toolchains's avatar
DJ Fragile Toolchains

@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.

➡️ writethedocs.org/conf/portland

DJ Fragile Toolchains's avatar
DJ Fragile Toolchains

@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.

➡️ writethedocs.org/conf/portland

Paolo Amoroso's avatar
Paolo Amoroso

@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.

lisp-docs.github.io

Paolo Amoroso's avatar
Paolo Amoroso

@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.

lisp-docs.github.io

LabPlot's avatar
LabPlot

@LabPlot@floss.social

New User Documentation 📚 🚀

@labplot@lemmy.kde.social

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:

➡️ labplot.org/2024/12/20/new-lab

Boosts appreciated! 🙂 :boost_love:

ignace nyamagana butera's avatar
ignace nyamagana butera

@nyamsprod@phpc.social

I am looking for a technical review of my doc to see if everything is understandable. github.com/bakame-php/http-str 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

Karsten Schmidt's avatar
Karsten Schmidt

@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 , then for storage & my own tools for force-directed graph layout) and of the current prototype using (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...

Screenshot of a (somewhat chaotic) force-directed layout showing a sub-graph of a several dozen nodes representing people, projects, venues, events etc. and relationships between them. The caption below the image reads:

Fig. 3 Includes direct and indirect (2nd degree) relations and exhibits exponential growth of linked content. Because of the poor layout algorithm used, this amount of detail has become unreadable, but nicely shows to potential for users to explore this space of information in a multitude of ways by "travelling" along the connections.
ALT text detailsScreenshot of a (somewhat chaotic) force-directed layout showing a sub-graph of a several dozen nodes representing people, projects, venues, events etc. and relationships between them. The caption below the image reads: Fig. 3 Includes direct and indirect (2nd degree) relations and exhibits exponential growth of linked content. Because of the poor layout algorithm used, this amount of detail has become unreadable, but nicely shows to potential for users to explore this space of information in a multitude of ways by "travelling" along the connections.
Zoomed out force-directed graph representation of similar content as in the other image, i.e. a graph of people, orgs, events, genres, tools, references, regions, timeline info loosely related to computational art(s)...
ALT text detailsZoomed out force-directed graph representation of similar content as in the other image, i.e. a graph of people, orgs, events, genres, tools, references, regions, timeline info loosely related to computational art(s)...
Mark Wyner :vm:'s avatar
Mark Wyner :vm:

@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.

markwrites.io/guide-for-using-

New version with updates thanks to @stn, @katzentratschen, @DeltaWye, @ClaireFromClare, and @luca.

Glenn Sorrentino's avatar
Glenn Sorrentino

@gs@fosstodon.org

pros and - what are examples of software products with amazing and why?

mmalc's avatar
mmalc

@mmalc@mastodon.social · Reply to Chris Espinosa's post

@Cdespinosa

It must be almost 20 years since I wrote this.






Screenshot of documentation for the method componentsSeparatedByString: (https://developer.apple.com/documentation/foundation/nsstring/1413214-componentsseparatedbystring?language=objc)

The discussion section include a code example:

If list begins with a comma and space—for example, @", Norman, Stanley, Fletcher"—the array has these contents: @[@"", @"Norman", @"Stanley", @"Fletcher"].


Norman Stanley Fletcher was the name of Ronnie Barker’s character in the British sitcom Porridge.

https://en.wikipedia.org/wiki/Porridge_(1974_TV_series)
ALT text detailsScreenshot of documentation for the method componentsSeparatedByString: (https://developer.apple.com/documentation/foundation/nsstring/1413214-componentsseparatedbystring?language=objc) The discussion section include a code example: If list begins with a comma and space—for example, @", Norman, Stanley, Fletcher"—the array has these contents: @[@"", @"Norman", @"Stanley", @"Fletcher"]. Norman Stanley Fletcher was the name of Ronnie Barker’s character in the British sitcom Porridge. https://en.wikipedia.org/wiki/Porridge_(1974_TV_series)
Sarah Rainsberger's avatar
Sarah Rainsberger

@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!

rainsberger.ca/blog/50-docs-ti

Jeroen Ruigrok van der Werven's avatar
Jeroen Ruigrok van der Werven

@asmodai@mastodon.social

2.0

I'm Jeroen from the Netherlands and a problem solver.

Interests:











( )

:mastodon: Mike Amundsen's avatar
:mastodon: Mike Amundsen

@mamund@mastodon.social

Poor Documentation Is Costly: Here’s How to Fix It

thenewstack.io/poor-documentat

"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." --

Mark Wyner :vm:'s avatar
Mark Wyner :vm:

@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.

markwyner.medium.com/guide-for

Ben Tasker's avatar
Ben Tasker

@bentasker@mastodon.social

I skipped writing an whilst getting up and running, but correcting that now.

I'm Ben - I'm a & a . 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 ones.

I write at bentasker.co.uk & have been building a archive for a little over a decade, covering , and some other stuff

Ben Tasker's avatar
Ben Tasker

@ben@mastodon.bentasker.co.uk

Post account move

I'm Ben - I was at @bentasker but have now moved to @ben

I'm a and a . I do best when I'm tearing stuff apart to work out how to fix (or break) it. I occasionally write about as a result.

I write at bentasker.co.uk about various topics, gradually building up an archive of covering a range of things, but mostly around and development

ConTeXt group's avatar
ConTeXt group

@context@fosstodon.org

We often get questions about . There’s a lot, but not always as up-to-date and as well-structured as we would like...

Most is in the wiki:
wiki.contextgarden.net

There’s the “excursion”: wiki.contextgarden.net/ConTeXt
and the “not so short introduction” in several languages:
github.com/contextgarden/not-s
another one in German:
github.com/AKielhorn/Context-I
and in Chinese:
ctan.org/pkg/context-notes-zh-

The best place to ask questions is the mailing list:
ntg.nl/mailman/listinfo/ntg-co

ConTeXt group's avatar
ConTeXt group

@context@fosstodon.org

Gavin about for :

I am working with in . Here are the resources I use, roughly in the order I search when trying to solve a problem.

Manual (pragma-ade.nl/general/manuals/) This is most comprehensive and helpful source.
➤ MetaPost Manual (mirrors.ctan.org/systems/doc/m) This is not specific to ConTeXt, but it is very useful.
➤ The MetaFun page on the ConTeXt wiki (wiki.contextgarden.net/MetaFun)
🧵

Lisa Clarke's avatar
Lisa Clarke

@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: lisaclarke.net/tag/beautiful-j

I write 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 and , but other times it's or .

Happy to be here!

Alex Ball's avatar
Alex Ball

@polarweasel@hachyderm.io

Looking for my next role as a manager or lead technical writer.

I’m in British Columbia, Canada. Remote roles only.

Check me out on LinkedIn (linkedin.com/in/polarweasel/) and GitHub (github.com/polarweasel/)

Ceri Davies's avatar
Ceri Davies

@ceri@toot.wales

An , having moved permanently from @ceri@noc.social now.

I work in tech in Wales.
I like , loved , worked on both and mostly on

I like , being , and its ilk, and its many friends.

Musically into , , , 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 , be kind.

らりお・ザ・何らかの🈗然㊌ソムリエ's avatar
らりお・ザ・何らかの🈗然㊌ソムリエ

@lo48576@mastodon.cardina1.red

XHTML™ 2.0 - XHTML Structural Module
w3.org/TR/xhtml2/mod-structura

<p> がリストや表を持てるのか。うーん

らりお・ザ・何らかの🈗然㊌ソムリエ's avatar
らりお・ザ・何らかの🈗然㊌ソムリエ

@lo48576@mastodon.cardina1.red

XHTML™ 2.0 - XHTML Caption Module
w3.org/TR/xhtml2/mod-caption.h

ol は caption 要素を持てるのに ul は持たないんだ。言われてみると確かにそれで良さそうではあるが

らりお・ザ・何らかの🈗然㊌ソムリエ's avatar
らりお・ザ・何らかの🈗然㊌ソムリエ

@lo48576@mastodon.cardina1.red

XHTML™ 2.0 - XHTML Image Module
w3.org/TR/xhtml2/mod-image.htm

<img> のメディアが unavailable だった場合に alt text よりも内容のマークアップが使われるのとか、完全に本来あるべき姿でしょ

らりお・ザ・何らかの🈗然㊌ソムリエ's avatar
らりお・ザ・何らかの🈗然㊌ソムリエ

@lo48576@mastodon.cardina1.red

w3.org/TR/xhtml2/mod-structura

<blockcode> とか圧倒的に “正しい” だろ。なーにが <pre><code> じゃ

らりお・ザ・何らかの🈗然㊌ソムリエ's avatar
らりお・ザ・何らかの🈗然㊌ソムリエ

@lo48576@mastodon.cardina1.red

HTML 5 に sectioning content や sectioning root という概念があるのにわざわざ適切な h1〜h6 を使うことが “強く推奨” されていることに、また腹が立ってきた (定期的にこの件でブチギレしている)