toxi, to typescript
@toxi@mastodon.thi.ng avatar

Current status: Updating the https://thi.ng/geom readme to give a better overview of the full extensive API, ahead of the v8 release (soon)... Attached are screenshots of three sections of the readme showing:

  1. list of 32 shape types (both 2D and 3D)
  2. list of 54 polymorphic functions/operations to manipulate/convert/analyze shapes & shape hierarchies
  3. list of additional 40 shape creation functions

Still to come: Documenting the bundled preset implementations of:

  • vertex convolution kernels (3)
  • curve subdivision strategies (8)
  • polygon/polyline to bezier conversion strategies (3)
  • polygon tessellators (9)

(...and how most of these can be combined & applied iteratively. Some of the recent/existing examples are already hinting at the potential...)

#ThingUmbrella #Geometry #Visualization #SVG #Documentation #TypeScript #JavaScript

Screenshot of a section of the linked GitHub readme, showing a table of 54 polymorphic functions/operations to manipulate/convert/analyze shapes & shape hierarchies
Screenshot of a section of the linked GitHub readme, showing a list of links to additional 40 shape creation functions

donwatkins, to Writers
@donwatkins@fosstodon.org avatar

8 ways non-technical contributors can add value to an open source project #nontechnical #Documentation #writers

https://allthingsopen.org/articles/8-ways-contributors-add-value

jaapio, to markdown Dutch
@jaapio@phpc.social avatar

I'm investigating options that are available to create a table of contents in #markdown, really wondering what people are using to create that when writing markdown based docs.

Please boost for reach.

#documentation

jaapio,
@jaapio@phpc.social avatar

@dantleech that means that you do not have any influence on the order of the chapters? And all headers are included? Or can you specify the maximum level?

I do completely understand that you prefer RST as it is much more powerful and easier to extend with custom syntax. The reason why I'm looking for a way to build a TOC is because @phpdoc users do request for it.

dantleech,
@dantleech@fosstodon.org avatar

@jaapio @phpdoc depends. You can have per article TOC, or you can ... iterate over a set of pages, order them by whatever (anything in the front matter e.g. weight) and (probably) pull the header structure from them. It's essentially the save as the navigation.

I found that you can pretty much do anything in Hugo, it's just way less elegant than RST/Sphinx!

joachim, to random
@joachim@drupal.community avatar

I really hate haddocks' eyes in code #documentation 'Defines the Foo class', 'Provides an implementation of the foo plugin'. No. It IS the Foo class. It IS the foo plugin.

tikhonov_a, to random
@tikhonov_a@mastodon.social avatar

Why didn't anyone tell me about https://devdocs.io? You convert the site into a web application, enable the packages you need, download for offline access and enjoy fuzzy search, speed and smooth operation for free.

#devdocs #documentation

phpdoc, to php
@phpdoc@phpc.social avatar

phpDocumentor 3.5 is here! With better Guides support and now fully functional RST! Automatic generated class diagrams by querying your code base and much more!

Let us know what you like in this new release!

https://github.com/phpDocumentor/phpDocumentor/releases/tag/v3.5.0

danielsiepmann,

@phpdoc Thanks. I'm really looking forward to the "Extensions" feature as it sounds like something we wanna have for customer projects.

And I highly value the existing features in the release.

msquebanh, to Cambodia
@msquebanh@mastodon.sdf.org avatar

The Center of in collaboration with the in Program at , has announced the release of the final edition of the “Cambodia’s Hidden Scars” series.

The series provides an of the idea that human rights violations, armed conflict & cause & outcomes, using the Kingdom’s tragic past to explore themes.

https://asianews.network/cambodias-hidden-scars-final-book-highlights-healing-after-atrocities

amoroso, to VintageOSes
@amoroso@fosstodon.org avatar

A young developer who never used Windows 98 back in the day stumbled upon an introductory book on the operating system and posted his impressions on skimming it, which brought him joy. He wrote:

"I was also left with the impression that perhaps I would like more software to come with a physical manual."

https://jamesg.blog/2024/05/19/windows-98-manual

#windows98 #documentation #retrocomputing

jake4480,
@jake4480@c.im avatar

@amoroso haha thanks! Now I'm wondering how common they are.. I do see early web stuff sometimes.

amoroso,
@amoroso@fosstodon.org avatar

@jake4480 Maybe not that common as AbeBooks doesn't carry much.

cheukting_ho, to random
@cheukting_ho@fosstodon.org avatar

Hey if you want to discuss anything about #documentation please sign up at the board at the #DocSummit (room 317) - you can also sign up for lightning talks (documentation related)

#PyConUS

benjaoming, to random
@benjaoming@social.data.coop avatar

Interesting. Several Canonical projects are using Discourse as their #documentation platform.

As with documentation using wikis, it's nearly the opposite of Documentation As Code. Instead of benefiting from a relationship between documentation, the software, its versioning and CI platforms, it builds a direct relation between documentation, support and community.

Here's an introduction: https://discourse.ubuntu.com/t/documentation-contributions/35868

Rendered docs: https://microstack.run/docs

fedora, to random

Next Fedora Docs workshop will be on May 23 at 3pm EDT (7pm UTC). Great opportunity to plug into contributing documentation for Fedora!

➡️ https://discussion.fedoraproject.org/t/writing-workshop-schedule/101813/13

#Fedora #FedoraDocs #Linux #OpenSource #documentation

vdaron, to ShareYourMusic
@vdaron@mastodon.social avatar

Help Mastodon, I'm lost !

I'm looking for a alternative to Confluence to store my team documentation.

My short list today is
@dokuwiki
@xwikiorg
@ngpixel (Wiki.js) and
@MkDocs

What are you using ? What would you recommend ?

Boost would be appreciated. Thanks ! 🙂

pwaring,
@pwaring@fosstodon.org avatar

@vdaron I use Google Docs because it's easy to collaborate and I can keep a local copy (using rclone) in case Google ever deletes my account.

In the past I've used Mediawiki, which was a reasonable self-hosted option and had useful plugins, e.g. we could put it behind LDAP authentication.

jupiter, to dotnet
@jupiter@mastodon.gamedev.place avatar

(smol) JOB OFFER:

Fellow federated Technical Writers and Documentation Connoisseurs:

Where would I go to get someone to review my documentation for:

  • structure (didactic and otherwise)
  • accessibility
  • modernity
  • oversights

(also, if you have a friend or yourself to put forward for a consultation - I can likely spare adequate coin for your time, just send me your rate)

Topic is C# documentation for a game and simulation development library.

#TechnicalWriters #Documentation #dotNet

lclarke522, to random
@lclarke522@gardenstate.social avatar

The results of the WriteTheDocs salary survey are in: https://www.writethedocs.org/surveys/salary-survey/2023/

#writethedocs #documentation

adelgado, to llm
@adelgado@eu.mastodon.green avatar

Would be nice to have a LLM that you can train locally with your organization documentation, to be able to have an interface to easily find that information buried in decades of documents
#LLM #MachineLearning #documentation #FOSS

  • All
  • Subscribed
  • Moderated
  • Favorites
  • provamag3
  • thenastyranch
  • magazineikmin
  • InstantRegret
  • osvaldo12
  • cubers
  • rosin
  • Youngstown
  • slotface
  • Durango
  • everett
  • kavyap
  • khanakhh
  • DreamBathrooms
  • megavids
  • ngwrru68w68
  • Leos
  • modclub
  • cisconetworking
  • love
  • GTA5RPClips
  • ethstaker
  • mdbf
  • anitta
  • normalnudes
  • tester
  • tacticalgear
  • JUstTest
  • All magazines