Add first draft

Author: MaedahBatool

docs/cody/prompts-guide.mdx

@@ -26,7 +26,7 @@ Before you start writing prompts, preparing your codebase for Cody is essential.
 
 ## Treat Cody like a new team member
 
-When using Cody, it's helpful to treat it like a new team member unfamiliar with your codebase. This approach helps ensure that you provide Cody with the necessary context and information to generate accurate and contextually aware answers.
+When using Cody, it's helpful to treat it like a new team member unfamiliar with your codebase. This approach ensures you provide Cody with the necessary context and information to generate accurate and contextually aware answers.
 
 You should focus on providing Cody with all the necessary information, such as the codebase structure, function names, and any relevant docs. The more context and details you provide, the better Cody can assist you in generating relevant and accurate code. For example,
 
@@ -68,7 +68,7 @@ function calc($i, $t) {
 
 ## Write clear code comments and docstrings
 
-In addition to variable names, comments and docstrings are crucial in guiding Cody's understanding of your code. Treat them as a way to communicate with Cody, just like you would with a new engineer. Explain complex logic, algorithms, or project-specific concepts to give Cody context.
+In addition to variable names, comments, and docstrings are crucial in guiding Cody's understanding of your code. Treat them as a way to communicate with Cody, just like you would with a new engineer. Explain complex logic, algorithms, or project-specific concepts to give Cody context.
 
 ✅ Good example:
 
@@ -97,13 +97,13 @@ You can learn more about context [here](/cody/capabilities/context).
 
 ## Selecting the right LLM
 
-Cody offers a variety of LLMs for both chat and in-line edits by all the leading LLM providers. Each LLM has its strengths and weaknesses, so selecting the right one for your use case is important. For example, Claude 3.5 Sonnet and GPT-4o are powerful for code generation and provide accurate results. However, Gemini 1.5 Flash is a decent choice for cost-effective searches. So, you can always optimize your choice of LLM based on your use case.
+Cody offers a variety of LLMs for both chat and in-line edits by all the leading LLM providers. Each LLM has its strengths and weaknesses, so it is important to select the right one for your use case. For example, Claude 3.5 Sonnet and GPT-4o are powerful for code generation and provide accurate results. However, Gemini 1.5 Flash is a decent choice for cost-effective searches. So, you can always optimize your choice of LLM based on your use case.
 
 Learn more about all the supported LLMs [here](/cody/capabilities/supported-models).
 
 ## 2. Prompting
 
-Now that your code is well-prepared let's focus on writing effective prompts for Cody via the following best practices:
+Now that your code is well-prepared, let's focus on writing effective prompts for Cody via the following best practices:
 
 ## Provide specific information
 
@@ -211,21 +211,21 @@ Try adding any supplementary details regarding comments, debugging guidelines, e
 
 ## Prompts Library
 
-To accelerate and automate your work, you can leverage Cody's Prompt Library that helps you to build customizable building blocks (prompts), share your best prompts with your teammates, and enable site administrators to promote the best prompts to the rest of the organization.
+To accelerate and automate your work, you can leverage Cody's Prompt Library, which helps you build customizable building blocks (prompts), share your best prompts with your teammates, and enable site administrators to promote the best prompts to the rest of the organization.
 
-The Prompt Library is a system for creating and sharing customizable prompts and are designed it specifically to cater scalability, repeatability, and flexibility.
+The Prompt Library is a system for creating and sharing customizable prompts. It is explicitly designed for scalability, repeatability, and flexibility.
 
-You can learn more about the [Prompts and the Prompt Library here](/cody/capabilities/commands).
+Learn more about the [Prompts and the Prompt Library here](/cody/capabilities/commands).
 
 ## Example Prompts
 
-Let's take a look at some examples of good and reusable prompts that you can create via the Prompt Library.
+Let's examine some examples of good and reusable prompts that you can create via the Prompt Library.
 
-<Accordion title=" Prompt that specifies the language/framework version you are using">
+<Accordion title=" 1. Prompt that specifies the language/framework version you are using">
 
-This prompt can help you if Cody does not generate code in the right language/framework version. For example,
+This prompt can help if Cody needs to generate code in the correct language/framework version. For example,
 
->Cody generating code snippets using a newer [Spring](https://spring.io/) version that's incompatible with your legacy Java application, which runs Spring 3.x. This mismatch leads to examples utilizing features from Spring Boot 2.x that your project doesn't support.
+>Cody generates code snippets using a newer [Spring](https://spring.io/) version that's incompatible with your legacy Java application, which runs Spring 3.x. This mismatch leads to examples utilizing features from Spring Boot 2.x that your project doesn't support.
 
 The prompt to tackle this issue looks like this:
 
@@ -238,5 +238,67 @@ Testing framework: JUnit 4"
 
 ```
 
-By sharing this prompt with your team, everyone can ensure that Cody generates code compatible with your legacy system.
 </Accordion>
+
+<Accordion title="2. Prompt that instructs Cody to follow your organization's styleguide">
+
+This prompt can help if Cody needs to follow your organization's coding standards or styleguide. For example,
+
+>Your organization follows a specific Python coding styleguide that mandates using snake_case for variable names and requires docstrings for all functions. However, Cody might generate code that doesn't adhere to these conventions, leading to inconsistency in your codebase.
+
+The prompt to resolve this inconsistency will be:
+
+```
+Generate Python code that adheres to our organization's style guide, which includes the following requirements:
+
+Use snake_case for all variable and function names.
+Include docstrings for all functions, describing their purpose and parameters.
+Follow PEP 8 guidelines for code formatting, including indentation and line length.
+```
+
+</Accordion>
+
+<Accordion title="3. Prompt with enhanced generate-unit-tests capabilities">
+
+This prompt can help you if you want to generate unit tests for your code based on a specific format. For example,
+
+>You're working with Golang and need Cody to generate unit tests that comply with your team’s conventions. Your organization follows a specific structure for tests, including table-driven tests and `require` from the `testify` package for assertions. However, Cody might provide a simple test that does not align with your standards.
+
+While you can use the default `generate-unit-tests` prompt but to get the desired output, you can customize e the prompt to include the following:
+
+```
+Please generate Golang unit tests that adhere to the following conventions:
+
+Use table-driven tests for different input cases.
+Use the require package from testify for assertions.
+Follow idiomatic Go test naming conventions and structure.
+```
+
+</Accordion>
+
+<Accordion title="4. An onboarding prompt for new team members">
+
+This prompt can help you if you want to onboard new team members by providing them with a set of instructions or guidelines to get started with a project. For example,
+
+```
+@repo tell me about this project and how to set it up.
+```
+
+</Accordion>
+
+<Accordion title="5. Customized code documentation prompt">
+
+To encourage detailed and comprehensive docs of your codebase, you can create a prompt instructing Cody to generate documentation based on your styleguide. For example,
+
+```
+Please generate a docstring for the given Python function that adheres to our team's documentation standards. The docstring should include:
+1. A brief summary of the function's purpose.
+2. A description of each parameter, including name, type, and purpose.
+3. The return value, including its type and description.
+4. Any raised exceptions, if applicable.
+5. Example usage of the function, where relevant.
+```
+
+</Accordion>
+
+You can share all these prompt examples with your team members to help them get started with Cody. If you want others to make the most of these, you can also promote the best prompts.