This is not the manual; man pages—https://codeberg.org/grunfink/snac2snac(1)(user manual),snac(5)(formats) andsnac(8)(administrator manual) are what you are looking for.
https://squidfunk.github.io/mkdocs-material/blog/2025/11/05/zensical/ Zensical – A modern static site generator built by the Material for MkDocs team
Day 7: roxygen2 Advanced Tags and Cross-References 📝
Master documentation with advanced roxygen2 features, with markdown-style writing! 🎯
💡 Pro Tip: Use @inheritDotParams to inherit ... parameter documentation.
📚 Resources: https://roxygen2.r-lib.org
![Cross-references: 🔗
#' @seealso [other_function()], [pkg::function()]
#' @family utility functions
#' @inheritParams parent_function](https://cdn.fosstodon.org/media_attachments/files/115/677/937/504/088/418/original/6f0a3ba8626d3b0e.png)
This is not the manual; man pages—https://codeberg.org/grunfink/snac2snac(1)(user manual),snac(5)(formats) andsnac(8)(administrator manual) are what you are looking for.
Day 7: roxygen2 Advanced Tags and Cross-References 📝
Master documentation with advanced roxygen2 features, with markdown-style writing! 🎯
💡 Pro Tip: Use @inheritDotParams to inherit ... parameter documentation.
📚 Resources: https://roxygen2.r-lib.org
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://markwrites.io/guide-for-using-mastodon-search
New version with updates. Thanks: @stn, @katzentratschen, @DeltaWye, @ClaireFromClare, and @luca.
#Mastodon #Fediverse#FediTips #MastodonHelp #MastodonTips#Search#Help#Guide#Documentation
New #documentation: Enabling My laptop's fingerprint reader for #authentication on #linux
I found out that my work laptop has a fingerprint reader built into it (turns out the power button doubles up as a reader), so I wanted to get it set up for easy authentication on the move (it means not having to worry about CCTV catching you enter your password)
It turned out to be pretty simple, this post documents how to do so.
Magit manuals are available online again
https://github.com/magit/magit/issues/5472
#HackerNews #Magit #manuals #online #Magit #GitHub #open #source #documentation
#Lesson of the day: I waste time searching for a solution #online, then ask #AI, which gives me “wonderful” but completely wrong results. In the end, I read the official #documentation and solve it in a few seconds:
1. https://man.freebsd.org/tcsh/1 > 2. Ctrl-f > 3. type "redirect" > 4. "The shell cannot presently redirect diagnostic output without also redirecting standard output, but `(command > output-file) >& error-file' is often an acceptable workaround. ..."
#Documentation #UNIX #FreeBSD #Shell #scripting #terminal #tcsh #fixing
#Lesson of the day: I waste time searching for a solution #online, then ask #AI, which gives me “wonderful” but completely wrong results. In the end, I read the official #documentation and solve it in a few seconds:
1. https://man.freebsd.org/tcsh/1 > 2. Ctrl-f > 3. type "redirect" > 4. "The shell cannot presently redirect diagnostic output without also redirecting standard output, but `(command > output-file) >& error-file' is often an acceptable workaround. ..."
#Documentation #UNIX #FreeBSD #Shell #scripting #terminal #tcsh #fixing
AI documentation you can talk to, for every repo
#HackerNews #AI #documentation #AI #tools #tech #innovation #developer #resources
Why Chris Biscardi uses Typst for most of his technical writing. Document queries seem pretty neat.
I finally published a blog post explaining how you can do 3D VTubing on Linux: VTubing on Fedora KDE 42
(Hint: it's just VSeeFace in a WINE bottle! With a lot of cool extras and recommendations!)
I'm also formally announcing that I now stream mondays to fridays at 8 PM UTC (5 PM UTC-3 / Brasilia time) on https://twitch.tv/herzenschein. Mostly work on KDE documentation. Come and say hi, ask about KDE stuff there!
#KDE #Fedora #Linux #Stream #Streaming #Furry #FurryStreamer #FurryVTuber #VTuber #Twitch #Documentation
I finally published a blog post explaining how you can do 3D VTubing on Linux: VTubing on Fedora KDE 42
(Hint: it's just VSeeFace in a WINE bottle! With a lot of cool extras and recommendations!)
I'm also formally announcing that I now stream mondays to fridays at 8 PM UTC (5 PM UTC-3 / Brasilia time) on https://twitch.tv/herzenschein. Mostly work on KDE documentation. Come and say hi, ask about KDE stuff there!
#KDE #Fedora #Linux #Stream #Streaming #Furry #FurryStreamer #FurryVTuber #VTuber #Twitch #Documentation
Beginner-friendly, unofficial documentation for Helix text editor
https://helix-editor.vercel.app/start-here/basics/
#HackerNews #BeginnerFriendly #HelixEditor #Documentation #OpenSource #TextEditor #LearningResources
Rakhim emphasizes the importance of examples in software documentation.
https://rakhim.exotext.com/examples-are-the-best-documentation
Serious question for those using #AI to write code comments and code #documentation :
Isn't the kind of documentation it generates trivial?
I mean: if you are just describing what a method or class do, I can read that on the (clean) code myself. I don't need that repeated.
What I am interested in is the parts I can't infer from a quick read of the code. Why this decision was made. Why this method looks weird. Why this class hierarchy. Why this code that seems useless can't be deleted.
Serious question for those using #AI to write code comments and code #documentation :
Isn't the kind of documentation it generates trivial?
I mean: if you are just describing what a method or class do, I can read that on the (clean) code myself. I don't need that repeated.
What I am interested in is the parts I can't infer from a quick read of the code. Why this decision was made. Why this method looks weird. Why this class hierarchy. Why this code that seems useless can't be deleted.
