This issue was moved to a discussion.
You can continue the conversation there. Go to discussion →
[Question] When is docfx v3 scheduled for release? #7050
Comments
|
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. |
|
I have asked this questions a couple of times. Any news? |
|
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, |
|
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? 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. |
|
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? #7022 |
|
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. |
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. |
|
Thank you for an update (at last) 😄 |
|
As far as I can tell, this bit in the roadmap:
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? 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. |
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? |
|
I don't want to seem rude or pushy in any way, but time is running out, so are the quarters, and since your announcement in February with the reference to the coming quarter, unfortunately nothing more has been heard about version 3. Prototypes appear regularly now, but you can't see where the current state of affairs is. PDF still doesn't seem to go in these, a doc on how to use it doesn't seem to exist either. So slowly but surely I wonder if I will even live to see the release. That's why I ask you for a statement about the state of affairs, how things are going, also connected with the request to bring the roadmap up to date. |
Is there any update? |
|
@yufeih Looks like "next quarter" didn't work out. Dou have any updates for us on how your plans look like? |
|
Unfortunately, the plan didn't work out. @herohua or @markjulmar may have more info. |
|
Adding my request here for an official update on how things are going regarding the release of v3. |
In case the current state of affairs has changed in any way. *wink *wink |
|
Can anyone say why this project is now read only? |
|
Tired of waiting for any progress, we switched to Docusaurus, and we are super happy with the decision. |
|
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:
|
Have you figured out a good way to generate and include API docs into Docusaurus? |
|
@bitbonk, |
|
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. |
|
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! |
|
I'm going to close this issue - but it doesn't mean it has to be the end of the conversation! |
|
Where does this leave the docfx dotnet tool and .net core support? |
@markjulmar thanks for your reply! maybe could be worth to move this issue to discussions? |
This issue was moved to a discussion.
You can continue the conversation there. Go to discussion →
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!
The text was updated successfully, but these errors were encountered: