home.social

#docfx — Public Fediverse posts

Live and recent posts from across the Fediverse tagged #docfx, aggregated by home.social.

  1. Feeling like I should be able to publish the new API documentation site for @xunit in the next day or two.

    The last big issue to resolve is dealing with DocFX's `uid` collisions when trying to have more than one version of an API documented on the site at a time. Should be a fairly mechanical YML + JSON transformation after `docfx metadata`. #DotNet #DocFX

  2. Does anyone know of a good blog plugin for #DocFX?

    I wanna be able to have it build a simple blog feed similar to how e.g. jekyll does things. Preferably complete with an RSS feed and everything.

    I guess the worst case here is I could just embed another markdown blog engine into docfx. Hrm.

    #DotNet

  3. RenovateBot is a wonderful piece of software. 👏🏆

    In about 5 minutes, I added a custom manager that can pick up the latest #docfx release from nuget and plop it into the Dockerfile for our docfx-action project. Delightful that it was so simple & well-documented.

  4. Use #docfx? Ever wish you had Netlify deployment previews for your site?

    It's doable via @github actions!

    Here's our workflow: github.com/nunit/docs/blob/mas

    General steps:

    * Create a GitHub environment for the deployment
    * Push the built files to a Netlify deploy
    * Get the URL for the deployment
    * Post/update a sticky comment.

    #dotnet #github

  5. @lananovikova @chrischinchilla This looks very interesting. Could it be a replacement for #DocFX that we are using to document #dotnet based libraries and frameworks?
    dotnet.github.io/docfx

  6. @jonskeet This is the first time in many years, #docfx (v2) receives a significant improvement. I hope docfx development gets some new traction.

  7. Latest #OSS fun: the #nunit docs now have a sample project we pull code from for the #docfx docs. Ensures the examples are more reliable, allows us to use our own analyzers & tooling to refactor, lets us check our samples in CI, makes it easier to build out real samples in the future. Very happy about this!

    #dotnet

  8. A fun little bit of #oss hacking tonight! #docfx released a new version that runs as a #dotnet global tool. I was able to update the #nunit docs docfx-action #github action to drastically simplify it. It now is based on the #dotnet #ubuntu container with a small tool install. Then I updated the NUnit docs #devcontainer to be based on that, plus our node tooling.

    Simpler, faster, nicer. Feels good.

  9. I discovered some new (albeit very faint) sign of life in #DocFX
    github.com/dotnet/docfx/issues
    But it could just be yet another wishful misinterpretation like the many times before in the last few years.
    #dotnet #documentation #nuget #FOSS @bot

  10. The situation with writing #documentation for #dotnet libraries or frameworks is surprisingly bad.

    Previously we had #docfx and it looked promising at first but it has long become a dumpster fire: github.com/dotnet/docfx/issues

    AFAIK there is currently not a single all-in-the-box solution for #dotnet documentation right now. You are forced to build your own.

    @bot