Skip to content

Commit a0f231c

Browse files
Merge pull request #24 from OneFineStarstuff/penify/auto_doc_ae9de05_462cc
[Penify]: Documentation for commit - ae9de05
2 parents ae9de05 + 822b363 commit a0f231c

2 files changed

Lines changed: 29 additions & 0 deletions

File tree

next-app/app/docs/exec-overlay/board-pack/page.tsx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
export const metadata = { title: 'Board Pack - Commissioning Overlay' } as const;
22

33
// Reusable components
4+
/**
5+
* Renders a metric dial component displaying the change percentage from baseline to target.
6+
*/
47
function MetricDial({label, baseline, target, unit, color}: {label:string; baseline:number; target:number; unit:string; color:string}) {
58
const pct = Math.round(((target - baseline) / baseline) * 100);
69
const isPositive = pct > 0;
@@ -28,6 +31,19 @@ function MetricDial({label, baseline, target, unit, color}: {label:string; basel
2831
);
2932
}
3033

34+
/**
35+
* Renders a LoadCell component with dynamic styling based on load and trend.
36+
*
37+
* The function determines background, text, and trend colors based on the
38+
* provided load and trend values. It returns a styled div containing the
39+
* function name and trend indicator, ensuring visual representation aligns
40+
* with the specified load and trend states.
41+
*
42+
* @param {Object} params - The parameters for the LoadCell component.
43+
* @param {string} params.fn - The function name to display.
44+
* @param {'low'|'medium'|'high'} params.load - The load level affecting colors.
45+
* @param {'↗'|'→'|'↘'} params.trend - The trend indicator affecting colors.
46+
*/
3147
function LoadCell({fn, load, trend}: {fn:string; load:'low'|'medium'|'high'; trend:'↗'|'→'|'↘'}) {
3248
const bgColor = load === 'low' ? '#d1fae5' : load === 'medium' ? '#fef3c7' : '#fee2e2';
3349
const textColor = load === 'low' ? '#065f46' : load === 'medium' ? '#92400e' : '#991b1b';
@@ -40,6 +56,16 @@ function LoadCell({fn, load, trend}: {fn:string; load:'low'|'medium'|'high'; tre
4056
);
4157
}
4258

59+
/**
60+
* Render the Board Pack component for the Executive Readiness View.
61+
*
62+
* This component structures the layout into a main section containing various subsections, including a Capability Snapshot,
63+
* Organizational Load Heatmap, Milestone Timeline, Strategic Value Metrics, and an Activation Kit Schematic. Each subsection
64+
* presents critical information regarding organizational capabilities, resource allocation, and strategic goals,
65+
* facilitating decision-making for the board.
66+
*
67+
* @returns A JSX element representing the Board Pack layout.
68+
*/
4369
export default function BoardPack() {
4470
return (
4571
<main className="min-h-screen bg-slate-50 p-6">

next-app/app/docs/exec-overlay/executive-summary/page.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
export const metadata = { title: 'Executive Summary - Governance Commissioning' } as const;
22

3+
/**
4+
* Renders the Executive Summary component for the Responsible AI Governance Commissioning Overlay.
5+
*/
36
export default function ExecutiveSummary() {
47
return (
58
<main className="mx-auto max-w-4xl space-y-6 p-6">

0 commit comments

Comments
 (0)