Skip to content

Commit 2ce8cbd

Browse files
authored
Merge pull request #53 from MetabobProject/docs/image-updates
docs/image updates
2 parents b88ca0e + 1305e04 commit 2ce8cbd

17 files changed

+24
-85
lines changed

README.md

Lines changed: 4 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -24,79 +24,20 @@ Metabob is an AI-based code review tool that utilizes a combination of Graph Neu
2424
# Settings​
2525

2626
* To disable Metabob anlaysis from running every time code is saved, go to the extension settings and deselect the checkbox under the text "Metabob: **Analyze Document On Save**"
27-
28-
![](docs/img/docs-analyze-on-save.png)
2927
3028
* To change the backend LLM model Metabob uses to generate problem descriptions and code recommendations, select your preferred model from the "Metabob: **Backend Selection**" drop down menu
31-
32-
![](docs/img/docs-backend-selection.png)
3329
3430
* If you prefer to use one of the openai models, you need to authenticate by inputting your openai API key into the text field under "Metabob: ChatGPT Token" text field on Metabob's extension settings
3531

36-
![](docs/img/docs-openai-token.png)
37-
3832
# Usage​
39-
40-
1. Request an analysis
41-
42-
Users can request Metabob to analyze the file they are currently working on by:
43-
* Using the "**ANALYZE**" -button on the Metabob extension side panel
44-
45-
![analyze-document-sidepanel](docs/img/v2-analyze-sidepanel.png)
46-
47-
48-
* Opening the command palette and using the command "**Metabob: Analyze Document**"
49-
50-
![analyze-document-commandpalette](docs/img/v2-analyzedocument-commandpalette.png)
51-
52-
53-
* Saving the file (requires "**Analyze Document On Save**" to be enabled on the extension settings
54-
55-
56-
Users can confirm that the Metabob Analysis is running by seeing a loading icon next to a text "Metabob: Analyzing Document" on the bottom left corner of the VS Code editor.
57-
58-
![analysis-running](docs/img/v2-analysis-running.png)
59-
60-
61-
Once the analysis has finished, users can see problematic areas highlighted in red on the file they are currently viewing and requested analysis for from Metabob.
62-
63-
![highlighted-problem](docs/img/v2-problem-highlight.png)
6433

34+
1. Analyze code
6535

66-
2. View problem details
36+
2. View detected problems
6737

68-
Users can view problem details by hovering over the red highlighted problem regions in their code and clicking "**More Details**"
38+
3. Generate fixes for detected problems
6939

70-
![more-details](docs/img/v2-view-more-details.png)
71-
72-
73-
3. Generate code recommendations to fix detected problems
74-
75-
Users can generate code recommendations to fix the detected problems by:
76-
* Hovering over the red highlighted problem regions in their and clicking "**Fix**"
77-
78-
![fix-problem](docs/img/v2-fix-and-details.png)
79-
80-
81-
* Clicking the "**GENERATE RECOMMENDATION**" -button on the Metabob extension side panel when viewing problem details
82-
83-
![generate-recommendation](docs/img/v2-generate-rec-sidepanel.png)
84-
85-
86-
If users think that the generated code recommendation is not correct, they can generate another recommendation by using the "**REGENERATE**" -button
87-
88-
![regenerate-recommendation](docs/img/v2-regenerate-rec.png)
89-
90-
91-
Users can view the different generated code recommendations they have asked to generate by using the arrows below the code generated code recommendation
92-
93-
![view-recommendations](docs/img/v2-recommendation-pagination.png)
94-
95-
96-
Users can apply the generated code recommendations to their code by clicking the "APPLY" -button
97-
98-
![apply-recommendation](docs/img/v2-apply-recommendation.png)
99-
40+
![analysis-flow](docs/img/v2-analysis-flow.gif)
10041

10142

10243
# Data Policy

docs/img/v2-analysis-flow.gif

1.63 MB
Loading

docs/img/v2-analysis-running.png

-2.17 KB
Binary file not shown.

docs/img/v2-analyze-sidepanel.png

-10.9 KB
Binary file not shown.
-16.2 KB
Binary file not shown.

docs/img/v2-apply-recommendation.png

-45.8 KB
Binary file not shown.

docs/img/v2-fix-and-details.png

-39.7 KB
Binary file not shown.
-22 KB
Binary file not shown.

docs/img/v2-problem-highlight.png

-22.8 KB
Binary file not shown.
-45.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)