docfx
docfx copied to clipboard
dotnet
[Question] When is docfx v3 scheduled for release?
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!
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.
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.
We are also interested in an update so we can plan to allocate time for the migration.
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 👀
Would love to get involved with DocFx, but can't justify the effort until v3 drops.
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.
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?
Hi guys, did you manage to start working on this? I need to decide which platform to move to (i am on docusaurus now) and DocFX v3 has precedence, not sure if i can wait for much longer though.
I'm in the same boat... I've started the process of moving from docfx to "something else". v3 really needs to drop...
I'm in the same boat... I've started the process of moving from docfx to "something else". v3 really needs to drop...
I would just be happy to get a status update more often, otherwise people looks at this as a dead project.
Any updates? Can we expect v3 to drop with .NET 6 in November or after? I just started looking into v2 and although it works I would like to know if this project has a real future?
Second I also agree with @Sotty75. I understand if it can't be finished in a snap and teams are busy with all the net6/WinUI3/MAUI en VS2022 stuff going on but it would be great to be kept up to date.
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.
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.
Is v3 going to support .net core 5? https://github.com/dotnet/docfx/issues/7022
DocFX v3 currently targets .NET 6.0, so I don't think you'll be able to run it on .NET 5. https://github.com/dotnet/docfx/blob/ba6dcef726b9b8dd610373925b5198ada7bd656f/Directory.Build.props#L17
It should still be usable for generating documentation from .NET 5 assemblies, though.
Is v3 going to support .net core 5? #7022
As .net 5 EOL is May 8, 2022 , I don't think they'll even bother.
Is v3 going to support .net core 5? #7022
As .net 5 EOL is May 8, 2022 , I don't think they'll even bother.
I don't think they'll ever bother to release 3.0 either.... oh you were referring to .net core 5 support... silly me... #waiting-forever
I really do want to like docfx but the glacial pace has made me question using it :(
Yeah, the only thing that keeps me hopefull is that PR's keep being merged for V3 instead of the repo going dead like some other projects
I made myself the idea this is such a low priority project that they have not a schedule for the roadmap, but still willing to release at some point in time. Unfortunately, this situation is frustrating as they did set some expectations wich are being missed.
Hopeful that this project is not dead, but a little more communication would be most welcome.
The project is obviously being worked on at the moment. I would be personally interested to know what the current status is. The roadmap itself was updated almost half a year ago, and I unfortunately have no overview of what is still missing or how far away we are before the real release. Feedback would indeed be quite nice.
Maybe @yufeih can say something about it, or even update the roadmap, as he seems to be doing the main work in this project.
We may have something to share next quarter. Meanwhile I have an early prototype here. To set expectations, this is just an early prototype.
Thanks a lot, the prototype looks already pretty good. I am glad we got some updates :)
Thank you for an update (at last) 😄 To be honest, I'm not optimistic. "Something to share next quarter" does sound like they will share about their updated roadmap/timeframe etc. which might mean that a 3.0 release would be many quarters away.
As far as I can tell, this bit in the roadmap:
API Reference: Microsoft Docs uses a separate set of tools to ingest API references for a variety of programming languages in addition to C#.
is really saying "DocFX no longer generates API reference documentation."
I understand the argument that by separating this part out, it makes DocFX a more general-purpose tool. But the problem is, this API reference documentation was one of the main reasons for using DocFX in the first place!
Is this "separate set of tools" is publicly available? I've not been able to find it? And if not, what are we expected to do if we want to produce API Reference docs?
Well the wait continues..... #waiting-forever
I as well have been putting off using DocFx (and using alternatives) for years now, as V3 slowly comes around.
Am I seeing it correctly that currently, it can not actually generate code documentation and only the .md generation is in place? If this is not the case is there a publicly available sample to show how to do it?
Is there a timeline currently?
@idg10 - if "DocFX no longer generates API reference documentation.", then how come @yufeih's early prototype [here] shows API documentation? (https://docascode.github.io/template/api/catlibrary/).
As far as I understand they have code that generates the metadata files that are then consumed by docfx. This would mean that docfx is a more traditional static site generator and that multiple language support becomes way easier. These codebases however don't seem to be public yet.
We may have something to share next quarter. Meanwhile I have an early prototype here. To set expectations, this is just an early prototype.
I don't want to seem rude in any way, but am I missing something? Shouldn't there possibly be news about the release in the current quarter? We're already in the second third of this one, and so far I haven't read anything more about it. Has the release been postponed again, or is there another place where this announcement was made?
README.md says "DocFX is supported by the .NET Foundation." However, it's not listed in .NET Foundation Projects. Was it already retired as not satisfying the Eligibility or Health requirements?