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.

Sign up for GitHub

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

Jump to bottom

Specify documentation via .csproj #7317

Closed
ffMathy opened this issue Sep 21, 2018 · 5 comments
Closed

Specify documentation via .csproj #7317

ffMathy opened this issue Sep 21, 2018 · 5 comments
Labels
Resolution:Duplicate This issue appears to be a Duplicate of another issue

Comments

@ffMathy
Copy link

ffMathy commented Sep 21, 2018

When using dotnet pack, I can use properties like RepositoryUrl to use as the resulting .nuspec file's repository URL etc.

But what property do I set to specify documentation (<documentation target="documentation.md"/>)? Is it even possible to specify via .csproj files?

If not, it should be!
@ffMathy ffMathy changed the title Specify documentation via .csproj Specify documentation via .csproj Sep 21, 2018
@jainaashish
Copy link
Contributor

There is no such property in .nuspec file that's why there is no csproj property as well. But if you can inlcude any documentation file in your nupkg at the root or as part of content. Even readme.txt at the root of nupkg are also shown to the customers upon installing the package.

@jainaashish jainaashish added the Resolution:Question This issues appears to be a question, not a product defect label Sep 21, 2018
@ffMathy
Copy link
Author

ffMathy commented Sep 22, 2018

Erhm, there is such a property.

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

@ffMathy
Copy link
Author

ffMathy commented Sep 22, 2018 •
edited
Loading

Can you please re-open @jainaashish?

@StingyJack
Copy link
Contributor

@ffMathy - thats a spec currently under review. You can track the related work here

@jainaashish
Copy link
Contributor

@ffMathy I had not closed the issue (added a label only). But @StingyJack for pointing to the related issue. I'll close it as dupe of #6873

@jainaashish jainaashish added Resolution:Duplicate This issue appears to be a Duplicate of another issue and removed Resolution:Question This issues appears to be a question, not a product defect labels Sep 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Resolution:Duplicate This issue appears to be a Duplicate of another issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ffMathy @StingyJack @jainaashish