ruby.social is one of the many independent Mastodon servers you can use to participate in the fediverse.
If you are interested in the Ruby programming language, come join us! Tell us about yourself when signing up. If you just want to join Mastodon, another server will be a better place for you.

Administered by:

Server stats:

1K
active users

#documentation

11 posts10 participants0 posts today

I'm finding converting my personal tech notes to public blog posts more challenging than expected.

They've served me well as quick reference docs, code snippets, & cheat sheets. But they look like utter shit when I consider another person looking at them.

I've leaned too heavily on editing, proof-reading, & expanding existing public docs that my writing from scratch has atrophied.

It's a bit of a struggle; but, I want to get these off my local machine and improve my writing.

RiverREM - Generating River Relative Elevation Model (REM) Visualisations
--
github.com/OpenTopography/Rive <-- shared GitHub repository
--
opentopography.github.io/River <-- shared documentation
--
opentopography.org/blog/new-pa <-- shared Open Topography blog post about RiverREM
--
H/T Heidi Luchsinger / Open Topography
[this post should not be considered as an endorsement of this product aka caveat emptor]
#GIS #spatial #mapping #remotesensing #earthobservation #Python #LiDAR #RiverREM #visualisation #hydrology #water #river #rivervalley #floodplain #terraces #GitHub #opensource #opendata #DEM #REM #model #modeling #RiverRelativeModel #documentation #tutorial #learning #tool #elevation #raster #sinuosity #drainage

📅 Mark your calendar, grab a coffee ☕ — on April 30 (2–4pm CEST) you're invited to our #DocsReviewParty!

After a long road, the #Decidim documentation is finally updated to the latest version. Now we need you to help us review it!

Your feedback on structure, clarity, and content will help improve the docs for everyone — and it's a big step toward our goal of multilingual, community-driven #documentation by 2026.

🔗 Register: meta.decidim.org/assemblies/ei

📚 Check the docs: docs.decidim.org/en/v0.29/inde

#discord IS LITERALLY THE PROBLEM!

I'm shure fecking #dread has better moderation and I'd rather use #MicrosoftTeams + #Slack cuz those at least have proper #moderation tools.

  • And I'd rather subscribe to the #LKML and see my inbox getting hosed than using any shitty #SaaS!

Case in point: I'd rather #SelfHost all my comms infrastructure than to ever use something like Discord or any other #GDPR-violating SaaS that is just enshittification.

I'd rather recommend people to instead choose a tool that does everything but horrible to go with multiple smaller & good tools

Check @alternativeto and @european_alternatives for options.

More and more legal #docs / speciations I read from git repository. Markdown is common for this purpose.

The ability to pull sources and use what ever UI I prefer is so convenient

Dynamic table of content / structure is one of my favorite feature.

Over the past couple of months, I've been spending more time reviewing my tech notes from the last five years.

Partially out of a new interest in posting publicly & also trying to improve my writing.

Despite my placing numerous reference links & quotes in these notes, I feel that I'm really blurring the line between plagiarism, absorbing concepts & re-writing them in my own words.

These notes continue to be useful. Just can't quite place the source. A new imposter syndrome.

🌟 Behold the groundbreaking revelation that TigerBeetle's team has reinvented the wheel by ditching #Docusaurus for their docs! 🙄 Apparently, their obsession with "TigerStyle" and "methodology" provides an unparalleled reading experience – because nothing screams #innovation like rebuilding #documentation from scratch. 🐯📚
tigerbeetle.com/blog/2025-02-2 #TigerBeetle #TigerStyle #HackerNews #ngated

tigerbeetle.comWhy We Designed TigerBeetle's Docs from ScratchInsights, updates, and technical deep dives on building a high-performance financial transactions database.

Ah, yes, the classic "blame the user" defense: Man pages are the epitome of pristine #documentation, and if you can't decipher them, it's obviously your profound incompetence. 📚🔍 Clearly, the real issue is that you peasants insist on using those pesky programs that don’t reveal the hidden wisdom of man pages. 🤦‍♂️
whynothugo.nl/journal/2025/04/ #blameTheUser #manPages #userExperience #techHumor #programming #HackerNews #ngated

whynothugo.nlMan pages are great, man readers are the problem
Replied in thread

Addendum: I was wrong!

Original Post:

@dalias @servo already the #documentation seems to be #AI #hallucinated garbage.

  • I.e. not useable at all...

And yes, undocumented, buggy and inefficient code will be the result, even if we don't think IP would be an issue...

Infosec.SpaceKevin Karhan :verified: (@kkarhan@infosec.space)@delan@kolektiva.social @dalias@hachyderm.io apologies on my part as I seem to have conflated @servo@floss.social with some other project...

Documentation complaints.

The Curse of Knowledge is real in documentation; even big and pricey ecosystems skip basic information.

Two examples I ran into this morning:

1. GitHub's CODEOWNERS documentation does not explicitly mention where to create the file.

docs.github.com/en/repositorie

2. NPM's docs do not explain allowed characters in package names.

docs.npmjs.com/package-name-gu

GitHub DocsAbout code owners - GitHub DocsYou can use a CODEOWNERS file to define individuals or teams that are responsible for code in a repository.