s

Codium-ai · Sep 8, 2024 · 4b7d67b · 4b7d67b
1 parent a260909
commit 4b7d67b
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 8 deletions.
diff --git a/docs/docs/core-abilities/code_oriented_yaml.md b/docs/docs/core-abilities/code_oriented_yaml.md
@@ -1,2 +1,2 @@
-## YAML Prompting
+## Overview
 TBD
diff --git a/docs/docs/core-abilities/compression_strategy.md b/docs/docs/core-abilities/compression_strategy.md
@@ -1,5 +1,5 @@
 
-## PR Compression Strategy
+## Overview - PR Compression Strategy
 There are two scenarios:
 
 1. The PR is small enough to fit in a single prompt (including system and user prompt)

diff --git a/docs/docs/core-abilities/dynamic_context.md b/docs/docs/core-abilities/dynamic_context.md
@@ -1,2 +1,2 @@
-## Asymmetric and dynamic PR context
+## Overview - Asymmetric and dynamic PR context
 TBD
diff --git a/docs/docs/core-abilities/impact_evaluation.md b/docs/docs/core-abilities/impact_evaluation.md
@@ -1,2 +1,2 @@
-## Impact evaluation 💎
+## Overview - Impact evaluation 💎
 TBD
diff --git a/docs/docs/core-abilities/Interactivity.md → docs/docs/core-abilities/interactivity.md b/docs/docs/core-abilities/Interactivity.md → docs/docs/core-abilities/interactivity.md
diff --git a/docs/docs/core-abilities/line_localization.md b/docs/docs/core-abilities/line_localization.md
@@ -1,2 +1,2 @@
-## Line localization
+## Overview - Line localization
 TBD
diff --git a/docs/docs/core-abilities/metadata.md b/docs/docs/core-abilities/metadata.md
@@ -1,4 +1,4 @@
-## Local and global metadata injection with multi-stage analysis
+## Overview - Local and global metadata injection with multi-stage analysis
 (1)
 PR-Agent initially retrieves for each PR the following data:
 - PR title and branch name
@@ -50,3 +50,7 @@ __old hunk__
 (4) The entire PR files that were retrieved are used to expand and enhance the PR context (see [Dynamic Context](https://pr-agent-docs.codium.ai/core-abilities/dynamic-context/)).
 
 (5) All the metadata described above represent several level of analysis - from hunk level, to file level, to PR level, and enables PR-Agent AI models to generate more accurate and relevant suggestions.
+
+
+## Example result for prompt with metadata injection
+TBD
diff --git a/docs/docs/core-abilities/self_reflection.md b/docs/docs/core-abilities/self_reflection.md
@@ -1,2 +1,2 @@
-##  Self-reflection and suggestion cleaning and re-ranking
+##  Overview - Self-reflection and suggestion cleaning and re-ranking
 TBD
diff --git a/docs/docs/core-abilities/static_code_analysis.md b/docs/docs/core-abilities/static_code_analysis.md
@@ -1,2 +1,2 @@
-## Static Code Analysis 💎
+## Overview -Static Code Analysis 💎
 TBD