Skip to content

Commit 1606ebd

Browse files
committed
Refactor chart documentation for consistency
Updated documentation files for BarChart, DoughnutChart, LineChart, PieChart, PolarAreaChart, RadarChart, and ScatterChart. Introduced a `componentName` constant for dynamic naming, updated `pageUrl` constants, and modified `pageTitle`, `pageDescription`, `metaTitle`, and `metaDescription` to use string interpolation. This enhances maintainability and ensures uniformity across documentation. NOTE: This commit message is auto-generated using GitHub Copilot.
1 parent 60f7864 commit 1606ebd

7 files changed

Lines changed: 35 additions & 28 deletions

File tree

BlazorExpress.ChartJS.Demo.RCL/Pages/Docs/BarChart/BarChart_Doc_01_Documentation.razor

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,11 @@
4242
</Section>
4343

4444
@code {
45+
private const string componentName = nameof(BarChart);
4546
private const string pageUrl = DemoRouteConstants.Docs_BarChart;
46-
private const string pageTitle = "Bar Chart";
47-
private const string pageDescription = "Comprehensive API documentation for the Blazor <code>Bar Chart</code> component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
48-
private const string metaTitle = "Blazor Bar Chart API Reference & Configuration Guide";
49-
private const string metaDescription = "Comprehensive API documentation for the Blazor Bar Chart component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
47+
private const string pageTitle = $"Blazor {componentName} component";
48+
private const string pageDescription = $"Comprehensive API documentation for the Blazor <code>{componentName}</code> component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
49+
private const string metaTitle = $"Blazor {componentName} component API Reference & Configuration Guide";
50+
private const string metaDescription = $"Comprehensive API documentation for the Blazor {componentName} component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
5051
private const string imageUrl = @DemoImageSrcConstants.BarChart;
5152
}

BlazorExpress.ChartJS.Demo.RCL/Pages/Docs/DoughnutChart/DoughnutChart_Doc_01_Documentation.razor

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,11 @@
4242
</Section>
4343

4444
@code {
45+
private const string componentName = nameof(DoughnutChart);
4546
private const string pageUrl = DemoRouteConstants.Docs_DoughnutChart;
46-
private const string pageTitle = "Doughnut Chart";
47-
private const string pageDescription = "Comprehensive API documentation for the Blazor <code>Doughnut Chart</code> component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
48-
private const string metaTitle = "Blazor Doughnut Chart API Reference & Configuration Guide";
49-
private const string metaDescription = "Comprehensive API documentation for the Blazor Doughnut Chart component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
47+
private const string pageTitle = $"Blazor {componentName} component";
48+
private const string pageDescription = $"Comprehensive API documentation for the Blazor <code>{componentName}</code> component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
49+
private const string metaTitle = $"Blazor {componentName} component API Reference & Configuration Guide";
50+
private const string metaDescription = $"Comprehensive API documentation for the Blazor {componentName} component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
5051
private const string imageUrl = @DemoImageSrcConstants.DoughnutChart;
5152
}

BlazorExpress.ChartJS.Demo.RCL/Pages/Docs/LineChart/LineChart_Doc_01_Documentation.razor

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,11 @@
4242
</Section>
4343

4444
@code {
45+
private const string componentName = nameof(LineChart);
4546
private const string pageUrl = DemoRouteConstants.Docs_LineChart;
46-
private const string pageTitle = "Line Chart";
47-
private const string pageDescription = "Comprehensive API documentation for the Blazor <code>Line Chart</code> component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
48-
private const string metaTitle = "Blazor Line Chart API Reference & Configuration Guide";
49-
private const string metaDescription = "Comprehensive API documentation for the Blazor Line Chart component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
47+
private const string pageTitle = $"Blazor {componentName} component";
48+
private const string pageDescription = $"Comprehensive API documentation for the Blazor <code>{componentName}</code> component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
49+
private const string metaTitle = $"Blazor {componentName} component API Reference & Configuration Guide";
50+
private const string metaDescription = $"Comprehensive API documentation for the Blazor {componentName} component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
5051
private const string imageUrl = @DemoImageSrcConstants.LineChart;
5152
}

BlazorExpress.ChartJS.Demo.RCL/Pages/Docs/PieChart/PieChart_Doc_01_Documentation.razor

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,11 @@
4242
</Section>
4343

4444
@code {
45+
private const string componentName = nameof(PieChart);
4546
private const string pageUrl = DemoRouteConstants.Docs_PieChart;
46-
private const string pageTitle = "Pie Chart";
47-
private const string pageDescription = "This documentation provides a comprehensive reference for the <code>Block</code> component, guiding you through its configuration options.";
48-
private const string metaTitle = "Blazor Pie Chart Component";
49-
private const string metaDescription = "This documentation provides a comprehensive reference for the Block component, guiding you through its configuration options.";
47+
private const string pageTitle = $"Blazor {componentName} component";
48+
private const string pageDescription = $"Comprehensive API documentation for the Blazor <code>{componentName}</code> component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
49+
private const string metaTitle = $"Blazor {componentName} component API Reference & Configuration Guide";
50+
private const string metaDescription = $"Comprehensive API documentation for the Blazor {componentName} component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
5051
private const string imageUrl = @DemoImageSrcConstants.PieChart;
5152
}

BlazorExpress.ChartJS.Demo.RCL/Pages/Docs/PolarAreaChart/PolarAreaChart_Doc_01_Documentation.razor

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,11 @@
4242
</Section>
4343

4444
@code {
45+
private const string componentName = nameof(PolarAreaChart);
4546
private const string pageUrl = DemoRouteConstants.Docs_PolarAreaChart;
46-
private const string pageTitle = "PolarArea Chart";
47-
private const string pageDescription = "This documentation provides a comprehensive reference for the <code>Block</code> component, guiding you through its configuration options.";
48-
private const string metaTitle = "Blazor PolarArea Chart Component";
49-
private const string metaDescription = "This documentation provides a comprehensive reference for the Block component, guiding you through its configuration options.";
47+
private const string pageTitle = $"Blazor {componentName} component";
48+
private const string pageDescription = $"Comprehensive API documentation for the Blazor <code>{componentName}</code> component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
49+
private const string metaTitle = $"Blazor {componentName} component API Reference & Configuration Guide";
50+
private const string metaDescription = $"Comprehensive API documentation for the Blazor {componentName} component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
5051
private const string imageUrl = @DemoImageSrcConstants.PolarAreaChart;
5152
}

BlazorExpress.ChartJS.Demo.RCL/Pages/Docs/RadarChart/RadarChart_Doc_01_Documentation.razor

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,11 @@
4242
</Section>
4343

4444
@code {
45+
private const string componentName = nameof(RadarChart);
4546
private const string pageUrl = DemoRouteConstants.Docs_RadarChart;
46-
private const string pageTitle = "Radar Chart";
47-
private const string pageDescription = "This documentation provides a comprehensive reference for the <code>Block</code> component, guiding you through its configuration options.";
48-
private const string metaTitle = "Blazor Radar Chart Component";
49-
private const string metaDescription = "This documentation provides a comprehensive reference for the Block component, guiding you through its configuration options.";
47+
private const string pageTitle = $"Blazor {componentName} component";
48+
private const string pageDescription = $"Comprehensive API documentation for the Blazor <code>{componentName}</code> component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
49+
private const string metaTitle = $"Blazor {componentName} component API Reference & Configuration Guide";
50+
private const string metaDescription = $"Comprehensive API documentation for the Blazor {componentName} component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
5051
private const string imageUrl = @DemoImageSrcConstants.RadarChart;
5152
}

BlazorExpress.ChartJS.Demo.RCL/Pages/Docs/ScatterChart/ScatterChart_Doc_01_Documentation.razor

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,11 @@
4242
</Section>
4343

4444
@code {
45+
private const string componentName = nameof(ScatterChart);
4546
private const string pageUrl = DemoRouteConstants.Docs_ScatterChart;
46-
private const string pageTitle = "Scatter Chart";
47-
private const string pageDescription = "This documentation provides a comprehensive reference for the <code>Block</code> component, guiding you through its configuration options.";
48-
private const string metaTitle = "Blazor Scatter Chart Component";
49-
private const string metaDescription = "This documentation provides a comprehensive reference for the Block component, guiding you through its configuration options.";
47+
private const string pageTitle = $"Blazor {componentName} component";
48+
private const string pageDescription = $"Comprehensive API documentation for the Blazor <code>{componentName}</code> component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
49+
private const string metaTitle = $"Blazor {componentName} component API Reference & Configuration Guide";
50+
private const string metaDescription = $"Comprehensive API documentation for the Blazor {componentName} component, including configuration options, parameters, methods, events, child component parameters, and model properties.";
5051
private const string imageUrl = @DemoImageSrcConstants.ScatterChart;
5152
}

0 commit comments

Comments
 (0)