cake-contrib / cake-contrib/Cake.AssemblyInfoReflector

Add documentation XML to NuGet package

Open
#10 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
0
Forks
3
PR merge metrics
No merged PRs in 30d

Description

The addin contains XML comments for aliases, but doesn't ship with the documentation XML file. Therefore comments can't be shown on Cake website (e.g. https://cakebuild.net/extensions/cake-assemblyinforeflector/).
To have aliases documented on the Cake website the NuGet package needs to ship with the documentation XML in the NuGet package.

Contributor guide

No contributing guide indexed for this repository

Research direction

Inspect the addin's packaging and build configuration to find where the NuGet package contents are defined, then check how the XML documentation file is generated. Done means the package includes that XML file and the aliases can be displayed on the Cake website.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation, release
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.