cake-build / cake-build/website

Module detail page should show instructions how to register in Frosting

Open
#1,524 1 comment 0 reactions 0 assignees View on GitHub
enhancement help wanted up-for-grabs
Dominant language
HTML
Stars
52
Forks
256
Avg merge
4h 42m
Merged PRs (30d)
8

Description

On the module detail page we currently show how to add the module NuGet package to a Frosting project:

![image](https://user-images.githubusercontent.com/2190718/106670535-77e25000-65ad-11eb-81d3-ade8c77d8bfb.png)

But this is only the fist part to use the module in Frosting. The second part is to register the module with `UseModule`. It would be nice to be able to show this also in the usage section. For this we would need to search the assembly for `CakeModuleAttribute`, which usually registers a class implementing `ICakeModule` :

```
[assembly: CakeModule(typeof(UsuallyAClassThatImplementsICakeModule))]
```

With this information we should generate the `UseModule` calls for the Frosting usage example:

```
.UseModule()
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at the module detail page's usage section and trace how the existing NuGet package instructions are generated. Then inspect how the assembly can be searched for CakeModuleAttribute and how Frosting usage examples are assembled. Done means the example emits a UseModule call for each discovered module registration.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
build-system, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.