[Question] When is docfx v3 scheduled for release? #8277
Replies: 46 comments 1 reply
-
|
That is indeed a very valid question. I'm not even sure if the roadmap is still up to date. It was updated more than half a year ago, in July last year. It would be nice to know if the release is in the distant or near future. |
Beta Was this translation helpful? Give feedback.
-
|
Are there any news? As FSharpCSharp stated, the roadmap really seems outdated, so we are not sure about the state of things and even if there is progress at all. |
Beta Was this translation helpful? Give feedback.
-
|
I have asked this questions a couple of times. Any news? |
Beta Was this translation helpful? Give feedback.
-
|
We are also interested in an update so we can plan to allocate time for the migration. |
Beta Was this translation helpful? Give feedback.
-
|
If I had to guess, given the number of beta releases being triggered at the moment, I'd say they're going to drop it at BUILD so they're staying quiet so they don't ruin the announcement. Would be nice to get a response though 👀 |
Beta Was this translation helpful? Give feedback.
-
|
Would love to get involved with DocFx, but can't justify the effort until v3 drops. |
Beta Was this translation helpful? Give feedback.
-
|
We've just had other priorities that have taken precedence over a formal v3 release. We still have a bit of work to do on it before it's publicly consumable, but we expect to have it done later in the summer. The roadmap now describes the present state and the gaps of v3. |
Beta Was this translation helpful? Give feedback.
-
|
Is any of the outstanding work something that could be helped forward with community contributions? Or is it all stuff that basically needs to be done by team members? |
Beta Was this translation helpful? Give feedback.
-
|
Hi guys, |
Beta Was this translation helpful? Give feedback.
-
|
I'm in the same boat... I've started the process of moving from docfx to "something else". v3 really needs to drop... |
Beta Was this translation helpful? Give feedback.
-
I would just be happy to get a status update more often, otherwise people looks at this as a dead project. |
Beta Was this translation helpful? Give feedback.
-
|
Any updates? Can we expect v3 to drop with .NET 6 in November or after? Second I also agree with @Sotty75. Third docfx is a really awesome and powerfull tool. And since almost all developers (including me) hate writing documentation, Microsoft has the opportunity to offer a great tool here with v3. So i think it's a bit of a shame it doesn't have a higher priority. |
Beta Was this translation helpful? Give feedback.
-
|
I'm eager for an update on this as well. I'm anxious to adopt DocFx for a couple of projects, but with lack of support for key C# 9 features (such as records) and new C# 10 features (such as global using directives), it's not currently possible without sourcing from the assemblies. Alternatively, are we reaching a point where the beta releases are stable enough to deploy to NuGet? At minimum, it'd be nice to begin getting started with the latest release, and potentially report bugs as appropriate, without needing to e.g. check an independently maintained copy of the binaries into source code. Thank you for your hard work. |
Beta Was this translation helpful? Give feedback.
-
|
Is v3 going to support .net core 5? #7022 |
Beta Was this translation helpful? Give feedback.
-
|
DocFX v3 currently targets .NET 6.0, so I don't think you'll be able to run it on .NET 5. Line 17 in ba6dcef It should still be usable for generating documentation from .NET 5 assemblies, though. |
Beta Was this translation helpful? Give feedback.
-
Is there any update? |
Beta Was this translation helpful? Give feedback.
-
|
@yufeih Looks like "next quarter" didn't work out. Dou have any updates for us on how your plans look like? |
Beta Was this translation helpful? Give feedback.
-
|
Unfortunately, the plan didn't work out. @herohua or @markjulmar may have more info. |
Beta Was this translation helpful? Give feedback.
-
|
Adding my request here for an official update on how things are going regarding the release of v3. |
Beta Was this translation helpful? Give feedback.
-
In case the current state of affairs has changed in any way. *wink *wink |
Beta Was this translation helpful? Give feedback.
-
|
Can anyone say why this project is now read only? |
Beta Was this translation helpful? Give feedback.
-
|
Tired of waiting for any progress, we switched to Docusaurus, and we are super happy with the decision. |
Beta Was this translation helpful? Give feedback.
-
|
I think it should be apparent to anyone following the issues in this repo, that docfx is no longer meant for public consumption and that it solely exists to support https://learn.microsoft.com. The maintainers have basically stopped all communication with the community for several years now. Here are a some potential alternatives:
|
Beta Was this translation helpful? Give feedback.
-
Have you figured out a good way to generate and include API docs into Docusaurus? |
Beta Was this translation helpful? Give feedback.
-
|
@bitbonk, |
Beta Was this translation helpful? Give feedback.
-
|
I did exactly the same. docfx is dead to me which bummed me out. It does some stuff better than docusaurus but docusaurus has been better overall for numerous other reasons (notably the live reload). I ended up using docfx to generate the static content for c# in my c# project. If you want you can then add those html files to the docusaurus site... That's basically what I did (not quite, but close enough). I didn't restyle that doc. it's ugly and very visually different but for now, it works. |
Beta Was this translation helpful? Give feedback.
-
|
Sorry for the late response; I missed the tag earlier, thanks @yufeih! First apologies for the long response, we've been dark for a while, and we finally have a way forward to talk about. DocFX is not dead! It's been successfully used to create all sorts of internal and external static websites, including the original incarnation of Microsoft docs. In addition, there is still a community dedicated to supporting and improving this project - I know we've been quiet lately; life events and other changes have sidetracked several of us, but we're still around! Regarding the V3 branch -- that branch has been around for a looong time, and it was the primary place where a bunch of experimentation and work was happening - most of it to support <learn.microsoft.com>, as someone noted earlier. Officially, we (Learn PM and Engineering) aspired to make this an official release. However, as time has passed and the Learn site has evolved into something entirely different, we've realized it didn't make sense to continue down this road. Instead, our community efforts will focus on investing in the main branch and pulling some of the interesting ideas into it from V3 - more on that in a sec. To provide a little background: as you all know, DocFX was an instrumental tool in allowing Microsoft to build up a massive documentation site that supported various content types/schemas and a full build tool capable of generating an entire HTML/JS/CSS site from basic config and Markdown. Microsoft could not have created Docs without it. However, as Docs (now Learn) has evolved and added more dynamic content and capabilities, we found it more challenging to continue to rely on static page generation. A significant amount of code ended up in the client-side JavaScript to enable dynamic features, which added complexity, code conflicts, and in some cases, reduced page performance due to all the round trips to the server and DOM manipulation. The site has been moving to a dynamic server-side composition model to address these problems. This composition layer allows the pages to be dynamically constructed based on the environment, signed-in identity, and other runtime state information. This approach reduces the client-side JS significantly and has allowed us to innovate in several areas of the site. As you can imagine, this also has the side effect of dramatically reducing Learn's dependency on DocFX to generate content. It's still present, but the build system only uses pieces of it, and the produced output is more of an intermediate format than the final HTML. Given these changes in the publishing model, it made sense to stop the official development of V3 - so you won't see any more work on that branch for the Learn site itself. BUT - DocFX will continue to evolve! Several of the key contributors are discussing what's next. As mentioned above, we'll cherry-pick features and structural changes from the V3 branch (that version breaks several key scenarios we want to keep). The official roadmap (once it's decided) will determine how much gets pulled into the main branch, so stay tuned for that. If there's something in V3 that you found particularly exciting or think would be useful, let us know. Finally, building off that last statement, we are looking for additional contributors to the project to help us plan and implement new features and capabilities. If anyone is interested, please engage with the team in the discussion forums once the roadmap is up! |
Beta Was this translation helpful? Give feedback.
-
|
I'm going to close this issue - but it doesn't mean it has to be the end of the conversation! |
Beta Was this translation helpful? Give feedback.
-
|
Where does this leave the docfx dotnet tool and .net core support? |
Beta Was this translation helpful? Give feedback.
-
|
We are looking at various approaches to move to .NET core. One of the most challenging areas is to figure out a way forward with the managed reference pipeline: it is today using roslyn to reflect source code and assemblies, which presents many challenges in keeping up with csharp/vs update as well as moving to .NET core. |
Beta Was this translation helpful? Give feedback.
-
@markjulmar thanks for your reply! maybe could be worth to move this issue to discussions? |
Beta Was this translation helpful? Give feedback.
and others
-
Hi,
are there any news regarding a planned release date for docfx v3?
Right now we are thinking about using v3 for our documentation, but if it is still far away we might simply go ahead and use v2.
Especially important for us is generating html and pdf files from Markdown.
Thanks a lot!
Beta Was this translation helpful? Give feedback.
All reactions