fosstodon.org is one of the many independent Mastodon servers you can use to participate in the fediverse.
Fosstodon is an invite only Mastodon instance that is open to those who are interested in technology; particularly free & open source software. If you wish to join, contact us for an invite.

Administered by:

Server stats:

8.6K
active users

#readthedocs

0 posts0 participants0 posts today
Kevin Bowen 🐭<p>Late last week, I dusted off a project that had been abandoned by one of our drive-by volunteers about three years ago.</p><p>I was strugglin' a bit getting the dependency restraints updated and re-familiarizing myself with the repo and publishing configurations. I think that's in good shape now &amp; I can mostly focus on document conversion &amp; layout.</p><p>Now that I've got more familiarity with <a href="https://hachyderm.io/tags/Sphinx" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Sphinx</span></a> and <a href="https://hachyderm.io/tags/pandoc" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>pandoc</span></a> than I did three years ago, I looking forward to making some progress this week.</p><p>It's been a long time itch to scratch of mine &amp; now I've got some time &amp; motivation. We shall see....</p><p><a href="https://hachyderm.io/tags/Xfce" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Xfce</span></a> <a href="https://hachyderm.io/tags/Documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Documentation</span></a> <a href="https://hachyderm.io/tags/ReadTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>ReadTheDocs</span></a></p>
Aneesh Sathe<p><strong>Divine Documentation</strong></p><p class="">Dad was about my age when he said that reading the manual was better than hypothesis driven button pressing. For teenage me, that took too long. Sure, I may have crashed a computer or two but following my gut got me there. Of course my gut isn’t <em>that</em> smart. In the decades preceding, devices had converged on a common pattern language of buttons. Once learned, the standard grammar of action would reliably deliver me to my destination.&nbsp;</p><a href="https://aneeshsathe.com/wp-content/uploads/2025/07/image-from-rawpixel-id-441318-jpeg.jpg" rel="nofollow noopener" target="_blank"></a>Image of a nebula taken by the Hubble Telescope.<p>In programming I was similarly aided by the shared patterns across MATLAB, Python, R, Java, Julia, and even HTML. In the end however, dad was right. Reading documentation is the way. Besides showing correct usage, manuals create a new understanding of my problems. I am able to play with tech thanks to the people that took the effort and the care to create good documentation. This is not limited to code and AI. During the startup years, great handbooks clarified accounting, fundraising, and regulations, areas foreign to me.</p><p>I love good documentation and I write documentation. Writing good documentation is hard. It is an exercise in deep empathy with my user. Reaching into the future to give them all they need is part of creating good technology. Often the future user is me and I like it when past me is nice to now me. If an expert Socratic interlocutor is like weight training, documentation is a kindly spirit ancestor parting the mist.&nbsp;</p><p>Maybe it’s something about being this age but now I try to impart good documentation practices to my teams. I also do not discourage pressing buttons to see what happens. Inefficient, but discovery is a fun way to spike interest.</p><p>Meanwhile, I’m reading a more basic kind of documentation. Writing English. Having resolved to write more, I’m discovering that words are buttons. Poking them gets me to where I want, but not always. Despite writerly ambitions, the basics are lacking. This became apparent recently when I picked up the book Artful Sentences by Virginia Tufte*. It’s two hundred and seventy pages of wonderful sentences dissected to show their mechanics. I was lost by page 5. The book is, temporarily, in my anti-library.&nbsp;</p><p>So, I’m going to the basics, Strunk and White, and William Zinsser. I’m hoping that Writing to Learn (finished) and On Writing Well (in progress) provide sufficient context about reasons to write to make the most of S&amp;W, for the how, then somewhere down the road, savor Tufte.&nbsp;</p><p class="">* Those dastardly Tuftes are always making me learn some kind of grammar.</p><p><a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/ai/" target="_blank">#AI</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/business/" target="_blank">#Business</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/continuouslearning/" target="_blank">#ContinuousLearning</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/devlife/" target="_blank">#DevLife</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/documentation/" target="_blank">#Documentation</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/empathyindesign/" target="_blank">#EmpathyInDesign</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/knowledgesharing/" target="_blank">#KnowledgeSharing</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/leadership/" target="_blank">#Leadership</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/learninginpublic/" target="_blank">#LearningInPublic</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/manualsmatter/" target="_blank">#ManualsMatter</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/opensource/" target="_blank">#OpenSource</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/philosophy/" target="_blank">#philosophy</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/programming/" target="_blank">#Programming</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/readthedocs/" target="_blank">#ReadTheDocs</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/science/" target="_blank">#science</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/softwaredevelopment/" target="_blank">#SoftwareDevelopment</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/startups/" target="_blank">#Startups</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/strunkandwhite/" target="_blank">#StrunkAndWhite</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/techwriting/" target="_blank">#TechWriting</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/virginiatufte/" target="_blank">#VirginiaTufte</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/williamzinsser/" target="_blank">#WilliamZinsser</a> <a rel="nofollow noopener" class="hashtag u-tag u-category" href="https://aneeshsathe.com/tag/writingwell/" target="_blank">#WritingWell</a></p>
Jeff Jessie<p>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. <a href="https://hachyderm.io/tags/docs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>docs</span></a> <a href="https://hachyderm.io/tags/readthedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>readthedocs</span></a> <a href="https://hachyderm.io/tags/developers" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>developers</span></a></p>
Jeff Jessie<p>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. <a href="https://hachyderm.io/tags/readthedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>readthedocs</span></a> <a href="https://hachyderm.io/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>documentation</span></a> <a href="https://hachyderm.io/tags/developers" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>developers</span></a></p>
Monika Barget<p>I have asked <a href="https://akademienl.social/tags/GPT" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>GPT</span></a>-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 <a href="https://akademienl.social/tags/ChatGPT" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>ChatGPT</span></a> started a <a href="https://akademienl.social/tags/deepsearch" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>deepsearch</span></a> 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 <a href="https://akademienl.social/tags/readthedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>readthedocs</span></a> for sure! But has anyone got insights they'd like to share? Deep search sounds a lot like <a href="https://akademienl.social/tags/energywaste" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>energywaste</span></a> to me.</p>
Stylus<p>I am not sprinting at <a href="https://social.afront.org/tags/PyCon" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>PyCon</span></a> <a href="https://social.afront.org/tags/PyConUS" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>PyConUS</span></a> but I did work on <a href="https://github.com/jepler/wwvbpy" rel="nofollow noopener" target="_blank">one of my personal projects</a> today, re-working the CI a bit and putting the docs up on <a href="https://social.afront.org/tags/readTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>readTheDocs</span></a>.</p>
Back In Time<p>Coming from <a href="https://fosstodon.org/tags/MkDocs" class="mention hashtag" rel="tag">#<span>MkDocs</span></a> on <a href="https://fosstodon.org/tags/ReadTheDocs" class="mention hashtag" rel="tag">#<span>ReadTheDocs</span></a> , I think about migrating our projects user manual to <a href="https://fosstodon.org/tags/Asciidoc" class="mention hashtag" rel="tag">#<span>Asciidoc</span></a> using <a href="https://fosstodon.org/tags/asciidoctor" class="mention hashtag" rel="tag">#<span>asciidoctor</span></a> and/or <a href="https://fosstodon.org/tags/antora" class="mention hashtag" rel="tag">#<span>antora</span></a> .</p><p>But I wonder if there is a service like <a href="https://fosstodon.org/tags/readthedocs" class="mention hashtag" rel="tag">#<span>readthedocs</span></a> for <a href="https://fosstodon.org/tags/asciidoc" class="mention hashtag" rel="tag">#<span>asciidoc</span></a> based manuals available for <a href="https://fosstodon.org/tags/OpenSource" class="mention hashtag" rel="tag">#<span>OpenSource</span></a> or <a href="https://fosstodon.org/tags/foss" class="mention hashtag" rel="tag">#<span>foss</span></a> projects.</p><p>Important is that those platforms do support <span class="h-card" translate="no"><a href="https://social.anoxinon.de/@Codeberg" class="u-url mention">@<span>Codeberg</span></a></span> (<a href="https://fosstodon.org/tags/forgejo" class="mention hashtag" rel="tag">#<span>forgejo</span></a> aka <a href="https://fosstodon.org/tags/gita" class="mention hashtag" rel="tag">#<span>gita</span></a> ) code hosting, instead of Microsoft GitHub.</p>
Zhian N. Kamvar<p>I'm in a situation where an organization has a <a href="https://hachyderm.io/tags/ReadTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>ReadTheDocs</span></a> website registered as `&lt;project&gt;.io` (via <a href="https://hachyderm.io/tags/NameCheap" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>NameCheap</span></a>). 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:</p><p>1. move the documentation site to `docs.&lt;project&gt;.io`<br>2. set `&lt;project&gt;.io` to host the landing page built on <a href="https://hachyderm.io/tags/GitHub" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>GitHub</span></a> with links out to `&lt;project&gt;.io`</p><p>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:</p><p>1. register `docs.&lt;project&gt;.io` and add that to the domains in <a href="https://hachyderm.io/tags/ReadTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>ReadTheDocs</span></a><br>2. set `&lt;project&gt;.io` as the CNAME for the GitHub site<br>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.</p><p>Is there anything else that I'm missing? <a href="https://hachyderm.io/tags/Web" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Web</span></a> <a href="https://hachyderm.io/tags/DNS" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>DNS</span></a></p>
griff<p>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 <a href="https://vmst.io/tags/neomutt" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>neomutt</span></a>, <a href="https://vmst.io/tags/irssi" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>irssi</span></a>, <a href="https://vmst.io/tags/i3wm" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>i3wm</span></a>, <a href="https://vmst.io/tags/opnsense" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>opnsense</span></a>, <a href="https://vmst.io/tags/tmux" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>tmux</span></a>. I think this is more important than ever when it's so easy to use an <a href="https://vmst.io/tags/llm" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>llm</span></a> to search for information.</p><p><a href="https://vmst.io/tags/learning" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>learning</span></a> <a href="https://vmst.io/tags/readthedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>readthedocs</span></a></p>
Tobias Frech<p>Trying to use a <a href="https://ijug.social/tags/LLM" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>LLM</span></a> 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. <a href="https://ijug.social/tags/ReadTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>ReadTheDocs</span></a>!</p>
Habr<p>«Вымрут» ли печатные пользовательские инструкции?</p><p>В эпоху цифровизации техническая документация меняет свои формы и функции. Печатные издания, когда-то считавшиеся основным источником информации, постепенно уступают место онлайн-форматам. Однако остаётся вопрос: есть ли будущее у печатных документов, или их неизбежно ждёт забвение? В этой статье мы разберём преимущества и недостатки обоих форматов, а также рассмотрим современные инструменты, которые помогают создавать качественную и удобную документацию.</p><p><a href="https://habr.com/ru/companies/documenterra/articles/868362/" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">habr.com/ru/companies/document</span><span class="invisible">erra/articles/868362/</span></a></p><p><a href="https://zhub.link/tags/%D1%86%D0%B8%D1%84%D1%80%D0%BE%D0%B2%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>цифровизация</span></a> <a href="https://zhub.link/tags/%D1%82%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B0%D1%8F_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>техническая_документация</span></a> <a href="https://zhub.link/tags/%D0%BF%D0%B5%D1%87%D0%B0%D1%82%D0%BD%D1%8B%D0%B5_%D1%82%D0%B5%D0%BA%D1%81%D1%82%D1%8B" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>печатные_тексты</span></a> <a href="https://zhub.link/tags/%D0%BE%D0%BD%D0%BB%D0%B0%D0%B9%D0%BD" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>онлайн</span></a> <a href="https://zhub.link/tags/%D0%B8%D0%BD%D1%82%D0%B5%D1%80%D0%B0%D0%BA%D1%82%D0%B8%D0%B2%D0%BD%D0%BE%D1%81%D1%82%D1%8C" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>интерактивность</span></a> <a href="https://zhub.link/tags/%D0%B8%D0%BD%D1%81%D1%82%D1%80%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D1%8B" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>инструменты</span></a> <a href="https://zhub.link/tags/notion" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>notion</span></a> <a href="https://zhub.link/tags/readthedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>readthedocs</span></a> <a href="https://zhub.link/tags/gitbook" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>gitbook</span></a> <a href="https://zhub.link/tags/slack" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>slack</span></a></p>
Jkoan<p>The <a href="https://fosstodon.org/tags/navit" class="mention hashtag" rel="tag">#<span>navit</span></a> wiki has been offline since a long time now. But I finally got around to revisit the migration from <a href="https://fosstodon.org/tags/mediawiki" class="mention hashtag" rel="tag">#<span>mediawiki</span></a> to <span class="h-card" translate="no"><a href="https://fosstodon.org/@readthedocs" class="u-url mention">@<span>readthedocs</span></a></span>. So far it&#39;s not finished, but there is great progress. I already opened the PR at <a href="https://github.com/navit-gps/navit/pull/1281" target="_blank" rel="nofollow noopener" translate="no"><span class="invisible">https://</span><span class="ellipsis">github.com/navit-gps/navit/pul</span><span class="invisible">l/1281</span></a> to get the nice preview from <a href="https://fosstodon.org/tags/readthedocs" class="mention hashtag" rel="tag">#<span>readthedocs</span></a> <br />Preview:<br /><a href="https://navit--1281.org.readthedocs.build/en/1281/index.html" target="_blank" rel="nofollow noopener" translate="no"><span class="invisible">https://</span><span class="ellipsis">navit--1281.org.readthedocs.bu</span><span class="invisible">ild/en/1281/index.html</span></a><br />Any ideas how to make the Doc&#39;s even better?<br /><a href="https://fosstodon.org/tags/doc" class="mention hashtag" rel="tag">#<span>doc</span></a> <a href="https://fosstodon.org/tags/docs" class="mention hashtag" rel="tag">#<span>docs</span></a> <a href="https://fosstodon.org/tags/Documentation" class="mention hashtag" rel="tag">#<span>Documentation</span></a> <a href="https://fosstodon.org/tags/foss" class="mention hashtag" rel="tag">#<span>foss</span></a></p>
Kevin Bowen (has moved) :xfce:<p>About 2 or 3 years ago, I had some brave soul step up and volunteer to convert the <a href="https://fosstodon.org/tags/Xfce" class="mention hashtag" rel="tag">#<span>Xfce</span></a> <a href="https://fosstodon.org/tags/documentation" class="mention hashtag" rel="tag">#<span>documentation</span></a> over to the .rst format to publish to <a href="https://fosstodon.org/tags/readthedocs" class="mention hashtag" rel="tag">#<span>readthedocs</span></a> </p><p>I was busy at the time; but, I went ahead and set up the initial repos &amp; created the workflow that would allow them to publish the docs on the platform.</p><p>IIRC, they lasted several weeks and a handful of docs before they disappeared.</p><p>It&#39;s definitely not glamorous work.😞</p>
bmaxv<p><a href="https://noc.social/tags/python" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>python</span></a> <a href="https://noc.social/tags/sphinx" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>sphinx</span></a> I added <a href="https://noc.social/tags/darkmode" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>darkmode</span></a> to a <a href="https://noc.social/tags/readthedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>readthedocs</span></a> page and it was a one line change, due to the beautiful work done in the <a href="https://github.com/MrDogeBro/sphinx_rtd_dark_mode" rel="nofollow noopener" target="_blank"><span class="invisible">https://</span><span class="ellipsis">github.com/MrDogeBro/sphinx_rt</span><span class="invisible">d_dark_mode</span></a> <br>extension.</p><p>Do your part! </p><p>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.🤣</p>
msftcangoblowme<p><span class="h-card" translate="no"><a href="https://mastodon.online/@jarofgreen" class="u-url mention" rel="nofollow noopener" target="_blank">@<span>jarofgreen</span></a></span> along with <a href="https://mastodon.social/tags/readthedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>readthedocs</span></a> (<a href="https://mastodon.social/tags/rtd" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>rtd</span></a>) also consider a workflow for github pages.</p><p>The advantage of gh pages is a gh workflow can be used.</p><p>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</p>
westbrook<p>Have you been disappointed by the passage of time and its negative effect on webcomponents.org?</p><p>Think that <a href="https://mastodon.social/tags/webComponent" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>webComponent</span></a> deserve a place on the internet that belies how practical and productive they are in your work?</p><p>Wanna help the <a href="https://mastodon.social/tags/webComponentsCG" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>webComponentsCG</span></a> bring such a thing to life?</p><p>Join us on Discord (<a href="https://discord.gg/KzgaSbGc9q" rel="nofollow noopener" translate="no" target="_blank"><span class="invisible">https://</span><span class="">discord.gg/KzgaSbGc9q</span><span class="invisible"></span></a>) as we drive to do all this and more for the next generation of web components and web components consumers!</p><p><a href="https://mastodon.social/tags/webDev" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>webDev</span></a> <a href="https://mastodon.social/tags/w3c" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>w3c</span></a> <a href="https://mastodon.social/tags/readTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>readTheDocs</span></a> <a href="https://mastodon.social/tags/writeTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>writeTheDocs</span></a></p>
phantom49<p><a href="https://mastodon.social/tags/readthedocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>readthedocs</span></a> <a href="https://mastodon.social/tags/tech" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>tech</span></a> <a href="https://mastodon.social/tags/technology" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>technology</span></a> <a href="https://mastodon.social/tags/funny" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>funny</span></a> <a href="https://mastodon.social/tags/humor" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>humor</span></a> <a href="https://mastodon.social/tags/jokes" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>jokes</span></a> <a href="https://mastodon.social/tags/memes" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>memes</span></a></p>
Jeff Forcier<p>Also looks like I never bothered with `link rel="canonical"` on my OSS doc sites, so the impending <a href="https://social.coop/tags/ReadTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>ReadTheDocs</span></a> behavior change shouldn't actually require any work on my part! ☺️</p><p>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?</p>
Jeff Forcier<p>Huh, I had somehow totally missed the new shiny <a href="https://social.coop/tags/ReadTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>ReadTheDocs</span></a> 'app' domain!</p><p>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.</p><p>Very fancy and shiny! Also much more like other, generalist CI platforms, which makes sense in hindsight.</p>
🍒🌳 Hartmut Goebel<p>I'm seeking experiences in multi-language <a href="https://nerdculture.de/tags/documentation" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>documentation</span></a>, e.g in <a href="https://nerdculture.de/tags/Sphinx" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>Sphinx</span></a> <a href="https://nerdculture.de/tags/SphinxDoc" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>SphinxDoc</span></a>, <a href="https://nerdculture.de/tags/MkDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>MkDocs</span></a>, …</p><p>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?</p><p>The aim is to create docs for <a href="https://nerdculture.de/tags/tryton" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>tryton</span></a>. 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.</p><p><a href="https://nerdculture.de/tags/followerpower" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>followerpower</span></a> <a href="https://nerdculture.de/tags/PleaseBoost" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>PleaseBoost</span></a> <a href="https://nerdculture.de/tags/ReadTheDocs" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>ReadTheDocs</span></a> <a href="https://nerdculture.de/tags/RTD" class="mention hashtag" rel="nofollow noopener" target="_blank">#<span>RTD</span></a></p>