cake-build / cake-build/website
Add best-practices for documenting extensions
- Dominant language
- HTML
- Stars
- 52
- Forks
- 256
- Avg merge
- 4h 42m
- Merged PRs (30d)
- 8
Description
We should add best-practices how to document extensions for best integration with Cake website.
Points to consider:
* Add XML comments
* Summary on aliases class
* Examples for aliases
* Category on class and aliases
* Tags on NuGet packages
* Add XML documentation files to NuGet packages
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the requested best-practice areas: XML comments for aliases and categories, NuGet package tags, and XML documentation files in packages. Done means the Cake website contains clear guidance covering each listed point; the issue names no specific file, test, or entry point.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- xml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100