Improve documentation how to write addins
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- Half a day
- Newbie friendliness
- 74/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- html
- Domain
- build-system, documentation
Research direction
Start with the existing addins documentation at https://cakebuild.net/docs/extending/addins/ and review the linked generator-cake-addin, Cake.Addin.Analyzer, and Cake Contrib guidelines. Done means the page explains creating an addin from scratch, including generator options, and documents the available analyzers alongside the relevant best practices.
Written by the indexing model from the issue text.
Description
We should improve documentation how to create new addins for Cake. Currently we have some documentation here: https://cakebuild.net/docs/extending/addins/. We should add more detailed documentation how to write addins.
This includes mentioning of https://github.com/WormieCorp/generator-cake-addin and https://github.com/WormieCorp/Cake.Addin.Analyzer.
Also should mention Cake Contrib and guidelines etablished there: https://github.com/cake-contrib/Home/blob/master/Guidelines.md, https://github.com/cake-contrib/CakeContrib.Guidelines
TODO:
- Add best practices
- Add instructions how to create addin from scratch, including generator options
- Add documentation about available analyzers
- Dominant language
- HTML
- Stars
- 52
- Forks
- 256
- Avg merge
- 4h 42m
- Merged PRs (30d)
- 8
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cake-build/website
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
cake-build/website#3225 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
cake-build/website#3135 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
cake-build/website#3127 · 3 comments ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
cake-build/website#2748 ·
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
cake-build/website#2431 · 4 comments · 2 reactions ·
All issues in cake-build/website
Similar issues
-
type/automation type/tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
priority: p3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
googleapis/librarian#7636 ·
-
package-update
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
oSoWoSo/vOid_Community_repOsitory#147 · 1 comment ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
agentic-workflows cascade-suspected
Difficulty 1/5 Under an hour Newbie friendliness 88/100