add init staging explaination
This commit is contained in:
parent
baee96ebaf
commit
5a65a8a090
2 changed files with 65 additions and 21 deletions
|
|
@ -10,7 +10,7 @@
|
|||
"favicon": "/favicon.ico",
|
||||
"integrations": {
|
||||
"intercom": {
|
||||
"appId": "ljxo1nzr"
|
||||
"appId": "ljxo1nzr"
|
||||
}
|
||||
},
|
||||
"navigation": {
|
||||
|
|
@ -20,15 +20,11 @@
|
|||
"groups": [
|
||||
{
|
||||
"group": "🏠 Overview",
|
||||
"pages": [
|
||||
"index"
|
||||
]
|
||||
"pages": ["index"]
|
||||
},
|
||||
{
|
||||
"group": "🚀 Getting Started",
|
||||
"pages": [
|
||||
"getting-started/local-installation"
|
||||
]
|
||||
"pages": ["getting-started/local-installation"]
|
||||
},
|
||||
{
|
||||
"group": "🔧 Continuous Optimization",
|
||||
|
|
@ -43,22 +39,17 @@
|
|||
"pages": [
|
||||
"optimizing-with-codeflash/one-function",
|
||||
"optimizing-with-codeflash/trace-and-optimize",
|
||||
"optimizing-with-codeflash/codeflash-all"
|
||||
"optimizing-with-codeflash/codeflash-all",
|
||||
"optimizing-with-codeflash/staging"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "🧠 Core Concepts",
|
||||
"pages": [
|
||||
"codeflash-concepts/how-codeflash-works",
|
||||
"codeflash-concepts/benchmarking"
|
||||
]
|
||||
"pages": ["codeflash-concepts/how-codeflash-works", "codeflash-concepts/benchmarking"]
|
||||
},
|
||||
{
|
||||
"group": "⚙️ Configuration & Best Practices",
|
||||
"pages": [
|
||||
"configuration",
|
||||
"getting-the-best-out-of-codeflash"
|
||||
]
|
||||
"pages": ["configuration", "getting-the-best-out-of-codeflash"]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -100,9 +91,7 @@
|
|||
}
|
||||
},
|
||||
"contextual": {
|
||||
"options": [
|
||||
"copy"
|
||||
]
|
||||
"options": ["copy"]
|
||||
},
|
||||
"redirects": [
|
||||
{
|
||||
|
|
@ -125,11 +114,11 @@
|
|||
"href": "https://www.codeflash.ai/privacy-policy"
|
||||
},
|
||||
{
|
||||
"label": "Terms of Service",
|
||||
"label": "Terms of Service",
|
||||
"href": "https://www.codeflash.ai/terms-of-service"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
55
docs/optimizing-with-codeflash/staging.mdx
Normal file
55
docs/optimizing-with-codeflash/staging.mdx
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
title: "Staging Review for Optimizations"
|
||||
description: "Review and manage optimizations before creating pull requests with staging mode"
|
||||
icon: "layer-group"
|
||||
sidebarTitle: "Staging Review"
|
||||
keywords:
|
||||
[
|
||||
"staging review",
|
||||
"optimization preview",
|
||||
"pro feature",
|
||||
"batch review",
|
||||
"pull request management",
|
||||
]
|
||||
---
|
||||
|
||||
# Staging Review for Optimizations
|
||||
|
||||
<Note>This is a Pro feature available exclusively to Codeflash Pro users.</Note>
|
||||
|
||||
Staging Review allows you to preview and evaluate all optimizations before creating pull requests. This feature provides a centralized review interface where you can examine proposed changes and selectively create pull requests for approved optimizations.
|
||||
|
||||
## Benefits of Staging Review
|
||||
|
||||
- **Preview without PRs:** Review all optimization suggestions without cluttering your repository with multiple pull requests
|
||||
- **Batch review:** Examine all optimizations in one centralized location
|
||||
- **Selective PR creation:** Choose which optimizations to convert into pull requests
|
||||
- **Reduced noise:** Keep your repository's PR list clean while evaluating changes
|
||||
|
||||
## Using Staging Review
|
||||
|
||||
To optimize your codebase with staging review enabled, run:
|
||||
|
||||
```bash
|
||||
codeflash --all --staging-review
|
||||
```
|
||||
|
||||
This command will:
|
||||
|
||||
1. Analyze and optimize all functions in your codebase
|
||||
2. Store the optimizations in a staging area instead of creating PRs immediately
|
||||
3. Provide you with a staging interface to review all proposed changes
|
||||
|
||||
## Managing Staged Optimizations
|
||||
|
||||
Once optimizations are staged, you can:
|
||||
|
||||
- Review each optimization individually
|
||||
- Compare original and optimized code side-by-side
|
||||
- Create pull requests for selected optimizations directly from the staging interface
|
||||
|
||||
## Requirements
|
||||
|
||||
- Codeflash Pro subscription
|
||||
- Codeflash GitHub App installed in your repository
|
||||
- Latest version of the Codeflash CLI
|
||||
Loading…
Reference in a new issue