GitHub - cstyan/adbDocumentation: Better documentation of the ADB protocol, specifically for USB uses. https://github.com/cstyan/adbDocumentation #documentation #OpenSource #protocol #Android #GitHub #adb #usb

GitHub - cstyan/adbDocumentation: Better documentation of the ADB protocol, specifically for USB uses. https://github.com/cstyan/adbDocumentation #documentation #OpenSource #protocol #Android #GitHub #adb #usb
#python #sphinx #documentation
#Sphinx release 8.2.0 (2025-02-18)
- https://www.sphinx-doc.org/en/master/changes/index.html#release-8-2-0-released-feb-18-2025
- https://www.sphinx-doc.org/en/master/changes/index.html#features-added
- https://github.com/sphinx-doc/sphinx/releases/tag/v8.2.0
- https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#collapsible-admonitions
Thank you Adam Turner ! (https://github.com/AA-Turner, Python Committer and #PEP Editor. Maintainer of Sphinx and #Docutils)
For a long time I had a very basic way of archiving documents, articles and books. Filesystem with years as folders and the PDFs got some date and clever name. Now I switched to paperwork. It feels so much easier now to archive and access the documents, because of the full text search and labels. https://www.openpaper.work #Documentation #Archives #organisation #pdf #linux #foss
We'll also start publishing all of our blog articles here, too!
You are a #golang programmer OR kube/etcd #contributor OR experienced #etcd user OR experienced #documentation writer? etcd is looking for #mentees - If you are interested to become a contributor or even maintainer - join here https://docs.google.com/forms/d/e/1FAIpQLSdun9AsgBM-srIz_H_3mu25mV50xx3_Vj-QAR_OG_YpW6HXXw/viewform
Time to start in on operational documentation for the Brook UFB adapter/input boards. Not the most fun part of the project, but definitely a requirement. #electronics #documentation #gaming #fightstick
@suzannealdrich Currentky I’m just using a couple notes (md) in Joplin, but I could see maybe separating homelab docs into MkDocs or something else. I am using Trello to keep track of things I want to consider and implement. I was a bit hesitant to self-host my list of self-hosting tasks/bugs.
Do you have a structured system for keeping track of your setups? Are you a meticulous curator of computer configurations? A dotfile dilettante? A network note-taker?
I'm looking for sustainable, open-source-friendly ways to document and templatize system and network setups. I really am only interested in something easy to maintain, not tied to a specific proprietary tool, and useful for both tracking infrastructure state and making changes over time.
How do you manage this? Markdown wikis? Git-based IaC? YAML sprawl? Hand-etched stone tablets? Drop your thoughts, workflows, or favorite tools!
Just released version 2.14.0 of Typemill with an API feature that is finally described in the brand new documentation. There is also a preview of the upcoming AI integration with Kixote. Exiting times for Typemill, read all here: https://typemill.net/news/typemill-2-14-0-api-documentation
B A N K S Y | I have been celebrating his anonymity and his way of turning the art world upside down for years. Recently, an online... great two-hour documentary by the street artist. Absolutely worth seeing!
https://www.youtube.com/watch?v=E8HiOiXQUmg
#Streetart #Bansky #art #documentation
I want to #selfhost a #documentation software with a user management system which would allow me to tell who can access what. What are my options?
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/
Great open source projects need great documentation!
What’s your go-to documentation tool? Let’s talk!
Read more: https://allthingsopen.org/articles/4-open-source-documentation-tools
GitHub - BookStackApp/BookStack: A platform to create documentation/wiki content built with PHP & Laravel https://github.com/BookStackApp/BookStack #documentation #self-hosted #OpenSource #GitHub #wiki
If you write a successful #foss project and don't write in a wiki or similar format where people can JUST contribute without having to go through you or through a bureacratic nightmare to document how YOUR software works, you're an idiot.
Gotta have some fun sometimes when writing a boring documentation...
"We don't make mistakes in music and life."
- Kummeli Musacorner, 1991
(Spotted a couple of typos after taking this screenshot, damn it! Well, proves the point about mistakes