Skip to content

Remove benchmark calculator references from documentation #3741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 3 commits into from
Closed

Remove benchmark calculator references from documentation #3741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c2adc11
Initial plan
Copilot Nov 10, 2025
20ee0b4
Remove benchmark calculator references from documentation
Copilot Nov 10, 2025
c9c8dc4
Update PR description with comprehensive summary
Copilot Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/scripts/process-benchmarks.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ All benchmark source code is available in the [\`tools/speed-comparison\`](https

### Interactive Comparison

Want to estimate performance for your test suite? Try the [Benchmark Calculator](/docs/benchmarks/calculator) to see potential time savings.
Benchmark calculator removed.

---

Expand Down
40 changes: 4 additions & 36 deletions docs/BENCHMARKS_IMPLEMENTATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,14 +80,7 @@ Auto-generated page featuring:
- Links to interactive tools

#### Calculator Page
**File:** `docs/docs/benchmarks/calculator.md`

Interactive page for users to:
- Input their test count
- Select current framework
- Calculate potential time savings
- See annual productivity gains
- Understand ROI of migration
**Benchmark calculator removed.**

#### Methodology Page
**File:** `docs/docs/benchmarks/methodology.md`
Expand Down Expand Up @@ -128,25 +121,7 @@ import BenchmarkChart from '@site/src/components/BenchmarkChart';
---

#### 2. BenchmarkCalculator Component
**Files:**
- `docs/src/components/BenchmarkCalculator/index.tsx`
- `docs/src/components/BenchmarkCalculator/styles.module.css`

**Features:**
- Input fields for test count, current framework, runs per day
- Real-time calculations using actual benchmark data
- Displays current vs TUnit vs TUnit AOT times
- Shows daily and annual time savings
- Calculates team-level impact
- Responsive card-based layout
- Gradient highlights for AOT results

**Usage:**
```tsx
import BenchmarkCalculator from '@site/src/components/BenchmarkCalculator';

<BenchmarkCalculator />
```
**Benchmark calculator removed.**

---

Expand All @@ -161,7 +136,7 @@ import BenchmarkCalculator from '@site/src/components/BenchmarkCalculator';
- Auto-loads real benchmark data from JSON
- Fallback data for initial rendering
- Feature checkmarks (source-generated, parallel, AOT)
- Call-to-action buttons to detailed benchmarks and calculator
- Call-to-action button to detailed benchmarks
- Methodology link
- Gradient backgrounds and animations
- Fully responsive
Expand All @@ -182,7 +157,6 @@ import BenchmarkCalculator from '@site/src/components/BenchmarkCalculator';

Added new "Benchmarks" section with:
- Main benchmarks page (index)
- Calculator page
- Methodology page

Positioned between "Examples & Use Cases" and "Reference" for optimal discoverability.
Expand Down Expand Up @@ -266,17 +240,13 @@ TUnit/
│ ├── docs/
│ │ └── benchmarks/
│ │ ├── index.md [AUTO-GENERATED]
│ │ ├── calculator.md [NEW]
│ │ └── methodology.md [NEW]
│ │
│ ├── src/
│ │ ├── components/
│ │ │ ├── BenchmarkChart/
│ │ │ │ ├── index.tsx [NEW]
│ │ │ │ └── styles.module.css [NEW]
│ │ │ ├── BenchmarkCalculator/
│ │ │ │ ├── index.tsx [NEW]
│ │ │ │ └── styles.module.css [NEW]
│ │ │ └── BenchmarkHighlight/
│ │ │ ├── index.tsx [NEW]
│ │ │ └── styles.module.css [NEW]
Expand Down Expand Up @@ -308,7 +278,6 @@ npm start
Visit:
- http://localhost:3000 (homepage with benchmark section)
- http://localhost:3000/docs/benchmarks (detailed benchmarks)
- http://localhost:3000/docs/benchmarks/calculator (calculator)
- http://localhost:3000/docs/benchmarks/methodology (methodology)

### After First CI Run
Expand All @@ -332,7 +301,6 @@ Visit:
- Visit the deployed site after merge
- Homepage shows real speedup numbers
- Benchmarks page shows all test categories
- Calculator uses real data
- Charts render correctly

**Note:** You can review the PRs if desired, but they will merge automatically without intervention.
Expand All @@ -353,7 +321,7 @@ matrix:
The system automatically:
- Processes new results
- Adds new sections to documentation
- Includes in charts and calculator
- Includes in charts

### Styling Customization

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/benchmarks/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ All benchmark source code is available in the [`tools/speed-comparison`](https:/

### Interactive Comparison

Want to estimate performance for your test suite? Try the [Benchmark Calculator](/docs/benchmarks/calculator) to see potential time savings.
Benchmark calculator removed.

---

Expand Down
3 changes: 0 additions & 3 deletions docs/src/components/BenchmarkHighlight/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,6 @@ export default function BenchmarkHighlight(): JSX.Element {
<Link to="/docs/benchmarks" className={styles.primaryLink}>
View Detailed Benchmarks →
</Link>
<Link to="/docs/benchmarks/calculator" className={styles.secondaryLink}>
Calculate Your Savings
</Link>
</div>

<div className={styles.benchmarkNote}>
Expand Down
Loading
Loading