Skip to content
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

Packaging Documentation within the nupkg #108

Open
PeterOrneholm opened this issue Nov 21, 2019 · 1 comment
Open

Packaging Documentation within the nupkg #108

PeterOrneholm opened this issue Nov 21, 2019 · 1 comment
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@PeterOrneholm
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
NuGet and NuGet.org now supports Packaging Documentation within the nupkg. This allows for docs to be versioned for the specific package you use, offline scenarios and documentatyion next to the package at nuget.org.

https://github.com/NuGet/Home/wiki/Packaging-Documentation-within-the-nupkg

What area is it related to
All packages

Describe the solution you'd like
Embed a small Readme.md per package, that is more to the point on what that package does.

@PeterOrneholm PeterOrneholm added the enhancement New feature or request label Nov 21, 2019
@PeterOrneholm PeterOrneholm added this to the 3.0.0 milestone May 1, 2020
@PeterOrneholm
Copy link
Collaborator Author

Turns out it does not support readme.md, but we could (should) embed a lightweight readme.txt per project as we do in https://github.com/ActiveLogin/ActiveLogin.Authentication.

@PeterOrneholm PeterOrneholm self-assigned this May 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant