#docs
#docs and #documentation taking centre stage on https://www.twitch.tv/bholmesdev
So proud of the work @swithinbank spearheaded creating a fast, accessible, lightweight, eco-friendly docs solution. Come hear him talk about what went into building it, and watch him take it for a spin!
Docs + Astro = Starlight
I will be documenting @pixelfed ActivityPub federation and updating the new docs tonight!
https://beta-preview.pixelfed.io/guides/activitypub-federation #pixelfed #docs
Today's the day!
We're starting our read-through of *Accessibility for Everyone* by Laura Kalbag in the Write the Doc Slack Community's learn-tech-writing channel.
Not in Write the Docs? See how you can sign up here: https://www.writethedocs.org/slack/
#bookClub #a11y #accessibility #docs #documentation #writeTheDocs #technialWriting
โจ Explore our new API docs
Please keep in mind this is a beta preview, we are working hard to finish this!
Today I learned that `example.com/.net/.org/.edu` and the Top Level Domains `.example`, `.test`, and `.invalid` have all been reserved specifically for use in #documentation.
https://en.wikipedia.org/wiki/Example.com
https://en.wikipedia.org/wiki/.example
Here's how to set a timer or a stopwatch in #Google #Docs using the new Smart #Canvas chips so you can crank out those creative novels, work-based documents and more with less distractions. https://tchlp.com/45Kbz4o
If I want to demo some #code snippet for solving a problem in a few different languages and have a each language under a tab, what would be the best tool for that?
https://zealdocs.org/ an offline docs viewer for #developers #programming #docs
Continued research on #OpenSource #documentation, and I've gotta say โ as much as I like #markdown, it's really led us to a place where basically all docs everywhere look the same. Very little in terms of interactive docs or novel / inventive approaches to teaching. I mean, it's not a *terrible* place to be, just a bit... dull.
First release! Doxide: modern documentation for modern C++. Configure it with YAML, generate Markdown, publish it for the web with the marvelous Material for MkDocs by @squidfunk. Looking for feedback on this one and contributions welcome #cpp #cplusplus #docs #new #opensource #release https://doxide.org
@libreoffice I'm trying to figure out if I have some time to contribute to #LibreOffice #docs There has to be a few hours a month to spare...
Developer friends โ I could use some inspiration! What #OpenSource companies out there do you think provide great developer #documentation?
I like the #Hashicorp developer portal, but there must be many I haven't seen. Any suggestions appreciated!
Wired: Google May Delete Your Old Accounts. Hereโs How to Stop It https://www.wired.com/story/how-to-stop-google-delete-account-inactive/ #Tech #wired #TechNews #IT #Technology via @morganeogerbc #Security/SecurityAdvice #Gear/HowToandAdvice #GoogleKeep #Passwords #how-to #Google #advice #Gmail #email #Gear #docs
Wat een prachtige podcast
[DOCS] #122 - Solastalgie #docs
https://podcastaddict.com/docs/episode/156771705 via @PodcastAddict
#Office alternatives: I want something that fits into my completely unpredictable ecosystem. I use Android primarily. However I also use iOS, Windows10, macOS, and even occasionally some flavor of ChromeOS or linux. As of now I use Google Docs because it runs on everything and doesn't seem to choke on anything. I am coasting along and suddenly I need conditional formatting or complex styles and I am looking for something else again. I thought I might have found a solution in #collabora but it runs like a dead horse on Windows10 and menu commands take 10-15 seconds to open dialogs. Honestly #Google could probably solve my issues with a few standalone apps or even just a better styles system. I use primarily #Docs for notes. I do update or view the occasional spreadsheet or presentation but I do nearly everything in a Word Processor. For now I am just going to use #LibreOffice on #Windows10 and Google #Docs on everything else. #FML
A nifty little tool to get actionable feedback directly from your #docs (written by a great co-worker of mine): https://www.docsly.dev/ #giveitatry
Are there any #c4model rendering tools outside Java land? ๐
#docsascode #docs
At the end of my work week I write a quick summary of achievements in #obsidian (along with some other prompts) to give myself a sense of completion and closure - and stop myself working through the weekend.
Thought Iโd dump a few here:
โข Did a 10km #bike ride โจ
โข Started using #elk
โข Set up my #linuxgaming rig
โข Had the worlds smallest #docs #pr merged over at @nuxt
โข Took my cat, Mow-mow, to the vet, and she came away with a perfect report card! ๐๏ธ
โข Got my budget back on track with the #selfhosted "Actual Budget" app
โข Finished watching ContraPoints 2+ hour video essay "The Witch Trials of J.K. Rowling"
This is Mow-mow, btw:
The Boy went to a birthday party yesterday and apparently got lots of compliments on his new shoes. Rocking his #Docs.
Folks, the call for proposals for WTD Atlantic online-only #conference in September is open till May 15th!
Would love to see your talk there.
In case you are searching for a eas-to-use Kubernetes documentation ยปยป https://www.manifests.io/kubernetes/1.26
In case you are searching for a eas-to-use Kubernetes documentation ยปยป https://www.manifests.io/kubernetes/1.26
Diagnostic nomenclature for #disorders of #consciousness #DoCs is poorly evidenced, dangerous, needs overhauling. โvegetative stateโ is the worst & it should be abandoned immediately. It was always nihilistic, designed 2 make lives of clinicians easier by helping them dismiss lives of their patients. It is also unscientific, stemming not from observation but from violent ideology - a metaphysics that fragments the human being, privileging the mind and neglecting the body. https://aeon.co/essays/why-we-must-abandon-the-vegetative-state-diagnosis
If you were going through a #tutorial series, would you rather it avoid all hard/weird cases and rough edges, or would you rather be shown the hard stuff incrementally so you know how to handle it?
The #nix #documentation team is spinning up a tutorial series and Iโm trying to decide what the best path forward looks like. #docs
I've been having a lot of conversations about duplication across #docs at work recently.
Minimizing duplication is important, but I'm wary of introducing a lot of complexity to the docs platform just to avoid any duplication.
I'm a big fan of includes/partials, but going beyond that doesn't feel worth it to me.
What do other #documentation folks think?
Iโm going to figure out how to download the .NET/C#/etc docs for offline use. Not having docs when working offline is so frustrating for me.
If anyone already knows a good way, please let me know.
TIL https://gemdocs.org/ is a viable alternative to https://rubydoc.info (currently down). Also supports YARD docs and seems fairly fast.
#ruby #docs #yard #yardoc
How do our #docs work? ๐ฆน
We just published a new chapter in our Guide: Let's take a look at how we structure our #documentation and go through a typical Reference page in detail. ๐งญ
Have you visited our http://ASP.NET docs recently? We'd love to get feedback on your experience to help us improve!
Simply visit the docs below ๐ and take our <1 minute survey!
Have you visited our ASP.NET docs recently? We'd love to get feedback on your experience to help us improve!
Simply visit the docs below ๐ and take our <1 minute survey!
https://learn.microsoft.com/en-us/aspnet/core/?view=aspnetcore-7.0
Just inspected Google Docs UI out of curiosity and was met with this monstrosity: No semantic HTML, everything is a div ๐คฆโโ๏ธ
You would think the company building the most popular web browser knows how to properly design a web application.
#google #docs #semantic #html #accessibility #web #development #design #fail
My greatest contribution to #OpenSource so far has been trying to follow the #documentation, failing, and then fixing the documentation. #FOSS #docs #rtfm
Anyone who use d2lang in the past? https://d2lang.com/tour/intro/
Ode to AI in our apps
Writing emails and memos, no lack
Though it might not be perfect
It's still quite a feat
To help us on our daily tracks
Build and preview script to test your documentation changes locally works like QA test before you push your changes to the Docs site. It is written for Fedora Docs hosted at Pagure and GitLab, can be applied to GitHub.
https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/tools-localenv-preview/
#Google porta la intelยทligรจncia artificial generativa a #Docs i #Gmail per crear esborranys de text
https://www.diariodesevilla.es/tecnologia/Google-inteligencia-artificial-Docs-Gmail-video_0_1774924564.html
eicker.news #technews ยป#Google announces #AIfeatures in #Gmail, #Docs, and more to rival #Microsoft: Google will soon offer ways to #generate #text and #images using #machinelearning in its #Workspace products.ยซ https://www.theverge.com/2023/3/14/23639273/google-ai-features-docs-gmail-slides-sheets-workspace
Is there something like OpenAPI (hence an open specification) but instead of targeting HTTP APIs, focusing on software libraries in general?
Context: I'm evaluating documentation engines for Python that support narrative documentation + API reference. We basically have Sphinx (and JupyterBook), MkDocs, and pdoc.
However, what if I want to use modern static site generators like Hugo or Docusaurus, while adding a library reference as well? An API specification would be key here.
โAnyone who knows her just falls in love with her.โ
Tiny is a short film about a strong woman
The inspiration for the film Tiny is Ritchie Hemphillโs mother, Colleen. She is his role model and hero.
In the film, Colleen tells stories from her time as a girl growing up on the wild and unpredictable West Coast. Itโs a place that she says provided so much.
https://windspeaker.com/news/windspeaker-news/tiny-short-film-about-strong-woman
#FirstNations #Indigenous #film #InternationalWomensDay #docs #stopmotionanimation
@roytanck In the #docs channel on Slack I see the link https://github.com/WordPress/Documentation-Issue-Tracker/issues
Or ask the Documentation team on Slack directly and they will show you the way.
โค๏ธ https://devdocs.io/
Keyboard navigable, โload times as short as possibleโ, fuzzy search, โworks offline, on mobile, and can be installed as web appโ, and โwith a clean and readable user interfaceโ.
Hi, everybody! February is Infrastructure Month for omg.lol. Code freezes are a great time to prioritize the #docs backlog, so let me know what you'd most like to see documented!
https://omglol.news/2023/02/09/february-focus-our-big-upgrade
Priority of Knowledge Transfer =
Importance of Knowledge + Availability of Knowledge + Frequency of Knowledge
#KnowledgeTransfer #Documentation #Docs #WriteTheDocs #TechnicalDocumentation
The #Python docs will hopefully soon have a dark theme! ๐
Demo build at:
https://septatrix.github.io/cpython-dark-docs/
Please try it out and let us know if you find any big problems!
https://github.com/python/python-docs-theme/pull/44
Just released beanbag-docutils 2.1
This is a collection of extensions for #Sphinx that offers:
* Support for our Beanbag / @reviewboard doc standards (some improvements on the Google style): https://reviewboard.notion.site/Standard-Documentation-Format-4388f594d86547cc949b365cda3cf391
* Linking to #GitHub for all autodoc code
* Multi-DPI images
* Multi-line refs
* Per-page Intersphinx control
And lots more.
This release adds multi-DPI images for `.. image::`, Sphinx 6, GitHub Enterprise linking, and bug fixes.
LibreOffice 7.5 Community released! Did you know that 25% of the new features have been developed by 91 individual volunteers?
#opensource #libreoffice #foss #office #docs #calc #impress #free #oss #software #windows #macos #linux #community
@tanepiper@tane.codes @elk @tanepiper@hachyderm.io We'll get to the docs at one point. We need a features page listing all the things that Elk brings to the table. There is a lot to do still, so if someone reading this is keen on docs and want to help us pushing on that front, join https://chat.elk.zone and look for the #docs channel ๐
If you're a #TechnicalWriter looking for one or more #conferences to attend this year, make sure #WriteTheDocs Portland, Atlantic, or Australia is on your radar.
But if you're looking for something else, ClickHelp just published a list of 2023 conferences #TechCom adjacent.
https://clickhelp.com/clickhelp-technical-writing-blog/techcomm-conferences-in-2023/
Well, one of 6 endpoints have now #OpenAPI #docs. I totally need to improve my #documentation writing skills ๐
(Yet another) new instance = new #introduction! Hi, I'm Laura. I'm a #DeveloperAdvocate @suborbital, writing #docs in the #extensibility and #WebAssembly spaces. Previously a #math prof. I'm in the #ADHD or maybe #AuADHD zone of the #Neurodivergent world.
I'm comfiest in #Python but am learning #Go, and I'm into #ResponsibleAI, #BicycleInfrastructure, #ResearchAsRecreation, #SocialJustice, #pedagogy, #OwnYourData, #a11y, and #FuckWhiteSupremacy.
I like meeting kind people who do neat things!
Docs meeting, calls and streams today!
First, team meeting brainstorming/strategizing Astro Docs re: content/partnerships.
Then, looking forward to watching @LauraLangdon and @ben 's Docs Accessibility stream https://www.youtube.com/watch?v=SkPur5xtazs
And, our weekly open Community Call in the Astro Discord, where core team members share updates from around the project, we discuss proposals and recognize contributors! (Catch up on past calls at https://www.youtube.com/@astrodotbuild )
Join me this Tuesday the 29th at 10:30am PST / 18:30 UTC to learn about #accessibility in #docs specifically and De#vRel in general from @ben!