Seeing epic failures provides clarity when you are doing things correctly on your own teams. This last 5 days has been an adventure and the timer is still running. Absolutely avoidable if people would have read documentation. #docs #readthedocs #developers
#readthedocs
Sitting in Day 5 of troubleshooting and attempting to fix an issue in production that could have been avoided if the developers on that team would have read the documentation and shared details to the client to avoid the headache and breaking of critical features needed for normal workflows to work. #readthedocs #documentation #developers
I have asked #GPT-4.0 to translate a news report from Dutch to German for me because I wanted to inform my family about current debates in the Netherlands. I was surprised that #ChatGPT started a #deepsearch although I had not actively selected this feature. I had vaguely heard about it but never used it before, and I am still wondering what it actually does. I will have to #readthedocs for sure! But has anyone got insights they'd like to share? Deep search sounds a lot like #energywaste to me.
I am not sprinting at #PyCon #PyConUS but I did work on one of my personal projects today, re-working the CI a bit and putting the docs up on #readTheDocs.
Coming from #MkDocs on #ReadTheDocs , I think about migrating our projects user manual to #Asciidoc using #asciidoctor and/or #antora .
But I wonder if there is a service like #readthedocs for #asciidoc based manuals available for #OpenSource or #foss projects.
Important is that those platforms do support @Codeberg (#forgejo aka #gita ) code hosting, instead of Microsoft GitHub.
I'm in a situation where an organization has a #ReadTheDocs website registered as `<project>.io` (via #NameCheap). Note that no one in this organization are experts or even practitioners of web publishing. People are realizing that the documentation site is not the best landing page and want to do two things:
1. move the documentation site to `docs.<project>.io`
2. set `<project>.io` to host the landing page built on #GitHub with links out to `<project>.io`
The question is: how the heck does one go about doing this without borking everything? It's clear that external links to the documentation would need to change, but in the meantime, I can see the following:
1. register `docs.<project>.io` and add that to the domains in #ReadTheDocs
2. set `<project>.io` as the CNAME for the GitHub site
3. add JavaScript to the 404 page that detects if the link is attempting to point to the documentation site and provide the correct redirect.
I came across something recently that basically stressed the importance of understanding the tools you use on a daily basis to get the most out of them. It suggested that you need to get familiar with the primary sources of docs as well and not just distilled summaries that hold your hand and give you a generic solution to one particular problem your trying to solve. With that in mind, my reading list lately has been the official docs for #neomutt, #irssi, #i3wm, #opnsense, #tmux. I think this is more important than ever when it's so easy to use an #llm to search for information.
Trying to use a #LLM to find a solution I get instructions to use a piece of code from a framework. Looking into the documentation of this framework it states very clearly that this comes with a huge performance impact for my application. The answer from the LLM did not mention this in any way. #ReadTheDocs!
Dose someone have experience with digital #handbooks / #documentation in #Typemill #Readthedocs or #gitbook?
We used simple PDF files for documentation till now but want to switch to a dedicated documentation system.
It should be easy to use for non-techies, customizable, good structure and capable of showing pictures and videos.
Oh and we need to host it by our self.
Thanks in advance.
«Вымрут» ли печатные пользовательские инструкции?
В эпоху цифровизации техническая документация меняет свои формы и функции. Печатные издания, когда-то считавшиеся основным источником информации, постепенно уступают место онлайн-форматам. Однако остаётся вопрос: есть ли будущее у печатных документов, или их неизбежно ждёт забвение? В этой статье мы разберём преимущества и недостатки обоих форматов, а также рассмотрим современные инструменты, которые помогают создавать качественную и удобную документацию.
https://habr.com/ru/companies/documenterra/articles/868362/
#цифровизация #техническая_документация #печатные_тексты #онлайн #интерактивность #инструменты #notion #readthedocs #gitbook #slack
The #navit wiki has been offline since a long time now. But I finally got around to revisit the migration from #mediawiki to @readthedocs. So far it's not finished, but there is great progress. I already opened the PR at https://github.com/navit-gps/navit/pull/1281 to get the nice preview from #readthedocs
Preview:
https://navit--1281.org.readthedocs.build/en/1281/index.html
Any ideas how to make the Doc's even better?
#doc #docs #Documentation #foss
About 2 or 3 years ago, I had some brave soul step up and volunteer to convert the #Xfce #documentation over to the .rst format to publish to #readthedocs
I was busy at the time; but, I went ahead and set up the initial repos & created the workflow that would allow them to publish the docs on the platform.
IIRC, they lasted several weeks and a handful of docs before they disappeared.
It's definitely not glamorous work.😞
#python #sphinx I added #darkmode to a #readthedocs page and it was a one line change, due to the beautiful work done in the https://github.com/MrDogeBro/sphinx_rtd_dark_mode
extension.
Do your part!
If you would like to know more, you'll have to ask someone else, because I don't know much about how all that works.🤣
@jarofgreen along with #readthedocs (#rtd) also consider a workflow for github pages.
The advantage of gh pages is a gh workflow can be used.
Packages using a custom python build backend, is negatively affected by rtd not running off a workflow and instead assuming the build process is vanilla
Have you been disappointed by the passage of time and its negative effect on webcomponents.org?
Think that #webComponent deserve a place on the internet that belies how practical and productive they are in your work?
Wanna help the #webComponentsCG bring such a thing to life?
Join us on Discord (https://discord.gg/KzgaSbGc9q) as we drive to do all this and more for the next generation of web components and web components consumers!
Also looks like I never bothered with `link rel="canonical"` on my OSS doc sites, so the impending #ReadTheDocs behavior change shouldn't actually require any work on my part! ☺️
ETA: I did in fact do a quick search engine check to confirm that the problem canonical links solve (duplicate search engine results for the same actual page) doesn’t seeeeeeem to be a problem for me. So yay?
Huh, I had somehow totally missed the new shiny #ReadTheDocs 'app' domain!
Got real confused at the directions for enabling the new modular version of their classic “tweak your Sphinx conf on their end during builds” feature set (now known as "addons”) until I took a closer look.
Very fancy and shiny! Also much more like other, generalist CI platforms, which makes sense in hindsight.
I'm seeking experiences in multi-language #documentation, e.g in #Sphinx #SphinxDoc, #MkDocs, …
What system/tool can you recommend? How do you handle contributions in case a person not speaking English (which is the 'main' language) wants to add some section?
The aim is to create docs for #tryton. Thus as a bonus we need/want multi-country docs, too. E.g. for describing country-specific taxing — where we don't need information for France in the English master neither in the German translation, but the German translation needs different parts for Germany, Austria and Switzerland. (And things get worse counting in all the countries speaking English or French.) If you have experiences with this, please share.
Nové rozhraní #ReadTheDocs potěšilo
https://app.readthedocs.org/projects/multiflexi/builds/25599684/
Client Info
Server: https://mastodon.social
Version: 2025.04
Repository: https://github.com/cyevgeniy/lmst