-
Notifications
You must be signed in to change notification settings - Fork 644
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Feature]: DNDocs #10055
Comments
If you have a screenshot, please add it here. We need to triage first based on the information you provided to us. |
@JonDouglas |
Coincidentally, we (F# community) are working on a similar project for F# APIs. I wanted to point it how, because it looks like DNDocs is considering that all package published to NuGet are C# packages. versus type [<AllowNullLiteral>] ArrayConstructor =
[<Emit "new $0($1...)">]
abstract Create: size: int -> 'T[] I am mentioning this because, I think it is important to note that perhaps multiple services could need to be supported. |
This tool looks really cool. The feature has been on the back of my mind for years. As you mentioned, there are existing feature requests from 2019. The need was filled for a while by FuGetGallery. However, FuGetGallery has had availability issues and we disabled the link (#9783). I have some questions, @NeuroXiq.
Overall, this is an amazing project and I applaud your contribution to the .NET ecosystem. This may fill a need that FuGetGallery once filled. |
Hi! [Short answers]
[Questions]
Can a package author request a takedown How are packages with different languages handled How are deleted packages handled? From time to time there are malicious and DMCA takedowns on NuGet.org. [Long Answers] Where is the source code for the project Very short summary how it works: How I fetch nuget packages: - see 'GetDllAndXmlFromPackageAsync' method What are your scalability targets What package types are handled Does the link to DNDocs make sense when the package already has API documentation linked elsewher How would they control the final shape of the API docs What security considerations or mitigation do you have
When is a GitHub login required
Even with my best intence I will probably bankrupt if i want to scale this accordingly to the traffic and I think Summary: |
Hey @NeuroXiq, What a cool project! It definitely fits a missing gap in NuGet today regarding static API documentation for each package. Our team has plans to implement static API documentation on NuGet.org similar to other ecosystems like https://docs.rs/syn/2.0.72/syn/, https://jsr.io/@astral/astral/doc, and https://pub.dev/documentation/bloc/latest/bloc/bloc-library.html Here is what people would like to see on NuGet.org next based on a June 2024 survey: You can see how we generate API docs today via https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.hosting?view=net-8.0 or https://github.com/dotnet/dotnet-api-docs which would be a similar experience we hope to bring to NuGet.org. Now that brings us to this issue and DNDocs. We believe there is a time period to potentially add this experience to NuGet.org, with the understanding that we will likely bring a first-party experience relatively soon for every NuGet package overriding the need for DNDocs long-term. We don't know when we will do this work, so that could be months or even years from now. We would highly recommend first proposing this experience in NuGet/home and we can amplify the proposal to the .NET community for comments about the current experience of DNDocs and how it could help fill this gap temporarily. https://github.com/NuGet/Home/tree/dev/meta#how-do-i-create-a-proposal I took a quick look at the current experience and the challenge I personally see is that it takes ~40s to generate API docs for a package. Ideally, I'd be able to see the API docs instantly for the top X/1000 packages given they have 80% or so of the total downloads. To include this on NuGetGallery, I believe we will need a community proposal and to streamline the experience if possible for consumer traffic. Let's start with a community proposal first and that will help bring up questions, feedback, and excitement for this project. |
Thanks for response! As an example I generated 29,000 package versions: @JonDouglas : If NuGet team implement documentation for any package to be similar like on learn.microsoft I proposed DNDocs because I was not aware of this and current there are no possible way @joelverhagen |
Thank you kindly @NeuroXiq. If you need help expanding your proposal, I'd gladly help expand the language before we evangelize it to the community. I'll comment in that PR and get some team members to review. |
Related Problem
#6946
#9776
The Elevator Pitch
Short description
Looking on github.com repositories and nuget.org packages I noticed that lots of them does not
have documentation online. If I want to see classes, methods etc. I need to open source code
and look in the C# code about implemented feature. This is cumbersome.
I created DNDocs to host API Explorer exactly for this problem:
https://dndocs.com/i/nuget/AutoMapper/13.0.1
https://dndocs.com/i/nuget/Microsoft.EntityFrameworkCore/8.0.3
Long description
DNDocs is a simple API Explorer (documentation hosting platform).
DNDocs allows to generate and host API Docs online using Docfx.
After generating a project, server do not delete it - generated docs are stored on the server disk
(cached) and available immediately after generation. So generating occurs only once
and can took 1-5 minutes and then Docs are accessible immediately.
To Explore nuget package replace values in URL and open the page:
https://dndocs.com/i/nuget/{NugetPackageName}/{NugetPackageVersion}
Wait 1-5 minutes (if server generate is for the first time) and just click green button
on the right.
Additional informations
For example, people want to have API Explorer and I think DocFX can fit well here:
#6946
#9776
And also some people on github hosts docs on DNDocs:
https://github.com/madelson/DistributedLock
https://github.com/betalgo/openai
https://github.com/adamhathcock/sharpcompress
Summary
So thats all what I want to say in this request.
I would like to hear Your opinion about this feature and DNDocs project.
I'm open to any and all ideas.
Best Regards
Marek Węglarz / NeuroXiq
https://github.com/NeuroXiq/DNDocs
Additional Context and Details
Screenshots:
No response
The text was updated successfully, but these errors were encountered: