Skip to content

Commit

Permalink
Add new component to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mgriffin-scottlogic committed Jun 21, 2024
1 parent 0aeeee7 commit 6b108e3
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ flowchart TB
assumptions-and-limitation`"]
Note["`NoteComponent
note`"]
Disclaimer["`DisclaimerComponent
disclaimer`"]
ExpansionPanel["`ExpansionPanelComponent
expansion-panel`"]
end
Expand All @@ -26,11 +28,11 @@ flowchart TB
FormatCostRangePipe
end
CarbonEstimator --> CarbonEstimatorForm & CarbonEstimation & Assumptions
CarbonEstimator --> CarbonEstimatorForm & CarbonEstimation & Assumptions & Disclaimer
CarbonEstimatorForm ---> FormatCostRangePipe
CarbonEstimatorForm --> Note
CarbonEstimator & CarbonEstimatorForm ---> CarbonEstimationService
CarbonEstimatorForm & CarbonEstimation --> ExpansionPanel
CarbonEstimatorForm & CarbonEstimation & Disclaimer --> ExpansionPanel
CarbonEstimationService & Assumptions --> CarbonIntensityService
```

Expand Down Expand Up @@ -59,6 +61,10 @@ Uses the [CarbonIntensityService](services.md#carbonintensityservice) to get the

Highlights assumptions that will be made when certain options are selected.

## DisclaimerComponent

Displays disclaimer about how the tool should be used.

## ExpansionPanelComponent

Displays explanatory text that can be hidden if desired.

0 comments on commit 6b108e3

Please sign in to comment.