feat(dspy): Merge branch 'main' into feat/remove-get_convo-asserts

Author: Michael Jones

README.md

@@ -38,7 +38,7 @@ To make this more systematic and much more powerful, **DSPy** does two things. F
 
 ### Table of Contents
 
-If you need help thinking about your task, we recently created a [Discord server](https://discord.gg/VzS6RHHK6F) for the community.
+If you need help thinking about your task, we recently created a [Discord server](https://discord.gg/XCGy2WDCQB) for the community.
 
 1. **[Installation](#1-installation)**
 1. **[Tutorials & Documentation](#2-documentation)**
@@ -61,7 +61,7 @@ Ditto! **DSPy** gives you the right general-purpose modules (e.g., `ChainOfThoug
 
 **What if I have a better idea for prompting or synthetic data generation?** Perfect. We encourage you to think if it's best expressed as a module or an optimizer, and we'd love to merge it in DSPy so everyone can use it. DSPy is not a complete project; it's an ongoing effort to create structure (modules and optimizers) in place of hacky prompt and pipeline engineering tricks.
 
-**What does DSPy stand for?** It's a long story but the backronym now is **D**eclarative **S**elf-improving Language **P**rograms, p**y**thonically.
+**What does DSPy stand for?** It's a long story but the backronym now is **D**eclarative **S**elf-improving Language **P**rograms, p**y**thonically. We also go by **D**eclaratively **S**elf-improving **Py**thon, which is simpler :D
 
 ## 1) Installation
 

docs/README.md

@@ -2,6 +2,37 @@
 
 This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
+## Building docs locally
+
+To build and test the documentation locally:
+
+1. Navigate to the `docs` directory:
+   ```bash
+   cd docs
+   ```
+
+2. Install the necessary dependencies:
+   ```bash
+   npm install
+   ```
+
+3. Run the build command:
+   ```bash
+   npm run build
+   ```
+
+This will generate a static build of the documentation site in the `build` directory. You can then serve this directory to view the site locally. If you see the build failing make sure to fix it before pushing.
+
+## Continuous Integration (CI) Build Checks
+
+We have automated build checks set up in our CI pipeline to ensure the documentation builds successfully before merging changes. These checks:
+
+1. Run the `npm run build` command
+2. Verify that the build completes without errors
+3. Help catch potential issues early in the development process
+
+If the CI build check fails, please review your changes and ensure the documentation builds correctly locally before pushing updates.
+
 ## Contributing to the `docs` Folder
 
 This guide is for contributors looking to make changes to the documentation in the `dspy/docs` folder. 
@@ -15,9 +46,4 @@ git subtree pull --prefix=docs https://github.com/krypticmouse/dspy-docs master
 
 2. **Push your new changes on a new branch**: Feel free to add or edit existing documentation and open a PR for your changes. Once your PR is reviewed and approved, the changes will be ready to merge into main. 
 
-3. **Updating the website**: Once your changes are merged to main, they need to be pushed to the subtree repository that hosts the live documentation site. This step will eventually be done automatically, but for now, please run the following command to push the updated `docs` content to the website subtree repository:
-
-```bash
-#Ensure you are in the top-level dspy/ folder
-git subtree push --prefix=docs https://github.com/krypticmouse/dspy-docs master
-```
+3. **Updating the website**: Once your changes are merged to main, the changes would be reflected on live websites usually in 5-15 mins.

docs/api/assertions.md

@@ -101,12 +101,14 @@ We can declare these validation checks through `dspy.Suggest` statements (as we
 dspy.Suggest(
     len(query) <= 100,
     "Query should be short and less than 100 characters",
+    target_module=self.generate_query
 )
 
 dspy.Suggest(
     validate_query_distinction_local(prev_queries, query),
     "Query should be distinct from: "
     + "; ".join(f"{i+1}) {q}" for i, q in enumerate(prev_queries)),
+    target_module=self.generate_query
 )
 ```
 
@@ -133,12 +135,14 @@ class SimplifiedBaleenAssertions(dspy.Module):
             dspy.Suggest(
                 len(query) <= 100,
                 "Query should be short and less than 100 characters",
+                target_module=self.generate_query
             )
 
             dspy.Suggest(
                 validate_query_distinction_local(prev_queries, query),
                 "Query should be distinct from: "
                 + "; ".join(f"{i+1}) {q}" for i, q in enumerate(prev_queries)),
+                target_module=self.generate_query
             )
 
             prev_queries.append(query)