diff --git a/docs/docs/how-codeflash-works.md b/docs/docs/how-codeflash-works.md index 5c31bb1f6..20c038e49 100644 --- a/docs/docs/how-codeflash-works.md +++ b/docs/docs/how-codeflash-works.md @@ -25,7 +25,7 @@ To optimize code, Codeflash first gathers all necessary context from the codebas ## Verification of correctness -![Verification](/img/verification.svg) +![Verification](/img/codeflash_arch_diagram.gif) The goal of correctness verification is to ensure that when the original code is replaced by the new code, there are no behavioral changes in the code and the rest of the system. This means the replacement should be completely safe. @@ -60,4 +60,4 @@ Codeflash implements several techniques to measure code performance accurately. ## Creating Pull Requests -Once an optimization passes all checks, Codeflash creates a pull request through the Codeflash GitHub app directly in your repository. The pull request includes the new code, the speedup percentage, an explanation of the optimization, test statistics including coverage, and the test content itself. You can review and merge the new code if it meets your standards. Feel free to modify the code as needed—we welcome your improvements! \ No newline at end of file +Once an optimization passes all checks, Codeflash creates a pull request through the Codeflash GitHub app directly in your repository. The pull request includes the new code, the speedup percentage, an explanation of the optimization, test statistics including coverage, and the test content itself. You can review and merge the new code if it meets your standards. Feel free to modify the code as needed—we welcome your improvements! diff --git a/docs/static/img/CodeFlash_arch_diagram.gif b/docs/static/img/CodeFlash_arch_diagram.gif new file mode 100644 index 000000000..84ea9a0af Binary files /dev/null and b/docs/static/img/CodeFlash_arch_diagram.gif differ