home.social

#docfx — Public Fediverse posts

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

fetched live
  1. EXCLUSIVE: Consistency for the Aptivi Newsroom and API docs design

    Last week, we have reported that the June 2026 redesign for the Aptivi Blog had finished in two stages: design and structure. This took a lot of effort into ensuring that responsive design was applied across all form factors, including mobile phones and tablets. This was a project that was planned to fix problems that plagued the older design that we revealed back on February 2026 as part of the bigger milestone.

    As we have gathered great feedback, we’d like to extend this effort to include both the API documentation of our projects that use .NET and the Aptivi Newsroom website. We will perform the necessary changes to ensure that our design is:

    • Consistent: We will update both sites to be consistent with our new design language, including colors and other element properties.
    • Cohesive: We will update both sites to ensure that they become readable across all form factors.
    • Reliable: We will update both sites to make the design elements, such as text and images, adapt to different form factors, while making sure that problems related to design are resolved.

    This design change, however, has no schedule, so it will slowly roll out according to the results of our experiments. If things go well, we will start rolling it out to a small batch, such as Nitrocid and Terminaux, before extending to larger batches to make sure that any last-minute bugs with the design can be caught early.

    Aptivi Newsroom will get the updated design first, then the API documentation design update will come in tiers, which will span for three weeks, as we keep testing the new design to ensure that it reliably achieves our goal.

    Currently, there is no set date as to when we’ll start rolling out the changes, but we will showcase them to you in a separate Aptivi Newsroom article once we start pushing the design updates.

    #API #APIDocs #APIDocumentation #AptiviNewsroom #docfx #DocGen #Hugo #news #Newsroom #Tech #Technology #update
  2. EXCLUSIVE: Consistency for the Aptivi Newsroom and API docs design

    Last week, we have reported that the June 2026 redesign for the Aptivi Blog had finished in two stages: design and structure. This took a lot of effort into ensuring that responsive design was applied across all form factors, including mobile phones and tablets. This was a project that was planned to fix problems that plagued the older design that we revealed back on February 2026 as part of the bigger milestone.

    As we have gathered great feedback, we’d like to extend this effort to include both the API documentation of our projects that use .NET and the Aptivi Newsroom website. We will perform the necessary changes to ensure that our design is:

    • Consistent: We will update both sites to be consistent with our new design language, including colors and other element properties.
    • Cohesive: We will update both sites to ensure that they become readable across all form factors.
    • Reliable: We will update both sites to make the design elements, such as text and images, adapt to different form factors, while making sure that problems related to design are resolved.

    This design change, however, has no schedule, so it will slowly roll out according to the results of our experiments. If things go well, we will start rolling it out to a small batch, such as Nitrocid and Terminaux, before extending to larger batches to make sure that any last-minute bugs with the design can be caught early.

    Aptivi Newsroom will get the updated design first, then the API documentation design update will come in tiers, which will span for three weeks, as we keep testing the new design to ensure that it reliably achieves our goal.

    Currently, there is no set date as to when we’ll start rolling out the changes, but we will showcase them to you in a separate Aptivi Newsroom article once we start pushing the design updates.

    #API #APIDocs #APIDocumentation #AptiviNewsroom #docfx #DocGen #Hugo #news #Newsroom #Tech #Technology #update
  3. 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

  4. 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

  5. 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

  6. 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

  7. 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.

  8. 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.

  9. 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

  10. 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

  11. @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

  12. @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

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

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

  15. 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

  16. 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

  17. 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.

  18. 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.

  19. 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

  20. 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

  21. 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

  22. 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