Skip to content

Commit a5f9780

Browse files
committed
update CI/CD portion a bit
1 parent f2a251b commit a5f9780

File tree

3 files changed

+17
-18
lines changed

3 files changed

+17
-18
lines changed

docs/docs.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,23 @@
2222
{
2323
"group": "🚀 Getting Started",
2424
"pages": [
25-
"getting-started/local-installation",
26-
"getting-started/codeflash-github-actions"
25+
"getting-started/local-installation"
26+
]
27+
},
28+
{
29+
"group": "🔧 CI/CD Integration",
30+
"pages": [
31+
"getting-started/codeflash-github-actions",
32+
"optimizing-with-codeflash/optimize-prs",
33+
"optimizing-with-codeflash/benchmarking"
2734
]
2835
},
2936
{
3037
"group": "⚡ Optimization Workflows",
3138
"pages": [
3239
"optimizing-with-codeflash/one-function",
3340
"optimizing-with-codeflash/trace-and-optimize",
34-
"optimizing-with-codeflash/codeflash-all",
35-
{
36-
"group": "CI/CD Integration",
37-
"pages": [
38-
"optimizing-with-codeflash/optimize-prs",
39-
"optimizing-with-codeflash/benchmarking"
40-
]
41-
}
41+
"optimizing-with-codeflash/codeflash-all"
4242
]
4343
},
4444
{

docs/optimizing-with-codeflash/benchmarking.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ icon: "chart-line"
55
sidebarTitle: "CI Benchmarks"
66
keywords: ["benchmarks", "CI", "pytest-benchmark", "performance testing", "github actions", "benchmark mode"]
77
---
8-
# Using Benchmarks in CI
9-
10-
Codeflash is able to determine the impact of an optimization on predefined benchmarks, when used in benchmark mode.
8+
<Info>
9+
**Performance-critical optimization** - Define benchmarks for your most important functions and let Codeflash measure the real-world impact of every optimization on your performance metrics.
10+
</Info>
1111

1212
Benchmark mode is an easy way for users to define workflows that are performance-critical and need to be optimized.
1313
For example, if a user has an important function that requires minimal latency, the user can define a benchmark for that function.

docs/optimizing-with-codeflash/optimize-prs.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
---
22
title: "Optimize Pull Requests"
33
description: "Automatically optimize code changes in pull requests with GitHub Actions integration"
4-
icon: "git-pull-request"
4+
icon: "code-merge"
55
sidebarTitle: "PR Optimization"
66
keywords: ["pull requests", "github actions", "code review", "automated optimization", "dependent PR", "suggestions"]
77
---
88

9-
# Optimize Pull Requests
10-
11-
Codeflash can optimize your pull requests by analyzing the changes in the pull request
12-
and generating optimized versions of the functions that have changed.
9+
<Info>
10+
**Continuous optimization** - After initial setup, Codeflash will automatically review every new pull request and suggest performance improvements through comments and dependent PRs.
11+
</Info>
1312

1413
## How to optimize a pull request
1514
After following the setup steps in the [Automate Code Optimization with GitHub Actions](/getting-started/codeflash-github-actions) guide,

0 commit comments

Comments
 (0)