Merge pull request #64 from harishmohanraj/update-application-contrib…

…ution-guide Update application contribution guide
ag2ai · Dec 30, 2024 · 34dd1e7 · 34dd1e7
2 parents 5357977 + f98dd40
commit 34dd1e7
Showing 1 changed file with 35 additions and 23 deletions.
diff --git a/website/docs/Gallery.mdx b/website/docs/Gallery.mdx
@@ -14,27 +14,39 @@ Built something interesting with AutoGen? Submit a PR to add it to the list! See
 
 <ClientSideComponent Component={GalleryPage} componentProps={{galleryItems: galleryItems}} />
 
-## Contributing
 
-To contribute, please open a PR that adds an entry to the `data/gallery.json` file in the `src` directory. The entry should be an object with the following properties:
-
-```js
-{
-    "title": "AutoGen Playground",
-    "link": "https://huggingface.co/spaces/thinkall/AutoGen_Playground",
-    "description": "A space to explore the capabilities of AutoGen.",
-    "image": "default.png",
-    "tags": ["ui"]
-  }
-```
-
-The `image` property should be the name of a file in the `static/img/gallery` directory.
-The `tags` property should be an array of strings that describe the demo. We recommend using no more than two tags for clarity.
-Here are the meanings of several tags for reference:
-1. app: Using Autogen for specific applications.
-2. extension: Enhancing AutoGen beyond the features in current version.
-3. ui: Building user interface for AutoGen.
-4. tool: Strengthening AutoGen Agents with external tools.
-5. groupchat: Solving complex tasks with a group of Agents.
-
-if the existing ones do not precisely portray your own demos, new tags are also encouraged to add.
+## Contributing
+Thank you for your interest in contributing! To add your demo to the gallery, please create a Pull Request (PR) with the following details.
+
+  - Updated `website/snippets/data/GalleryItems.mdx` file with your application entry.
+
+  - The application image added to the `static/img/gallery` directory if the image is local. If the image is hosted online, just update the `image` property with the URL of the image.
+
+  - Below is an example of an entry in the `website/snippets/data/GalleryItems.mdx` file:
+
+    ```
+      {
+      "title": "AutoGen Playground", // The title of your demo
+      "link": "https://huggingface.co/spaces/thinkall/AutoGen_Playground", // URL to your demo
+      "description": "A space to explore the capabilities of AutoGen.", // A brief description
+      "image": "default.png", // Filename of the image present in the `static/img/gallery` directory or URL of the hosted image
+      "tags": ["ui"] // Tags to categorize your demo
+      }
+		```
+  - Refer to the below table for description of each property:
+
+    | Property     | Description                                                                                         |
+    |--------------|-----------------------------------------------------------------------------------------------------|
+    | `title`      | Provide a clear and concise title for your demo.                                                    |
+    | `link`       | Include a valid URL linking to your demo.                                                           |
+    | `description`| Write a short description (1-2 sentences) to summarize your demo.                                   |
+    | `image`      | Use the filename of an image stored in the `static/img/gallery` directory if the image is local.    |
+    |              | If the image is hosted online, ensure the URL is correctly added to the entry.                      |
+    | `tags`       | Add up to two tags that best describe your demo for clarity.                                        |
+    |              | Choose from the existing tags:                                                                      |
+    |              | - `app`: Using Autogen for specific applications.                                                   |
+    |              | - `extension`: Enhancing AutoGen beyond the features in the current version.                        |
+    |              | - `ui`: Building a user interface for AutoGen.                                                      |
+    |              | - `tool`: Strengthening AutoGen Agents with external tools.                                         |
+    |              | - `groupchat`: Solving complex tasks with a group of Agents.                                        |
+    |              | Or propose new tags if the existing ones do not describe your demo. Ensure they are descriptive and concise. |