From 8581c7ecce378be4f96088fdd6e8f8025e9c0df7 Mon Sep 17 00:00:00 2001 From: Taranjeet Singh Date: Sat, 30 Sep 2023 15:46:09 -0700 Subject: [PATCH] docs: add contribution section (#744) --- README.md | 2 +- docs/contribution/dev.mdx | 1 - docs/contribution/guidelines.mdx | 4 ++++ docs/contribution/javascript.mdx | 4 ++++ docs/contribution/python.mdx | 4 ++++ docs/mint.json | 10 ++++++++-- 6 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 docs/contribution/guidelines.mdx create mode 100644 docs/contribution/javascript.mdx create mode 100644 docs/contribution/python.mdx diff --git a/README.md b/README.md index b5b2fac7..24faf40e 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![Substack](https://img.shields.io/badge/Substack-%23006f5c.svg?logo=substack)](https://embedchain.substack.com/) [![Open in Colab](https://camo.githubusercontent.com/84f0493939e0c4de4e6dbe113251b4bfb5353e57134ffd9fcab6b8714514d4d1/68747470733a2f2f636f6c61622e72657365617263682e676f6f676c652e636f6d2f6173736574732f636f6c61622d62616467652e737667)](https://colab.research.google.com/drive/138lMWhENGeEu7Q1-6lNbNTHGLZXBBz_B?usp=sharing) -Embedchain is a framework to easily create LLM powered bots over any dataset. If you want a javascript version, check out [embedchain-js](https://github.com/embedchain/embedchainjs) +Embedchain is a framework to easily create LLM powered bots over any dataset. If you want a javascript version, check out [embedchain-js](https://github.com/embedchain/embedchain/tree/main/embedchain-js) ## Community diff --git a/docs/contribution/dev.mdx b/docs/contribution/dev.mdx index e392b7d4..6a850961 100644 --- a/docs/contribution/dev.mdx +++ b/docs/contribution/dev.mdx @@ -42,7 +42,6 @@ embedchain is built on the following stack: ### Maintainer - Deshraj Yadav ([@deshrajdry](https://twitter.com/taranjeetio)) -- [cachho](https://github.com/cachho) ### Citation diff --git a/docs/contribution/guidelines.mdx b/docs/contribution/guidelines.mdx new file mode 100644 index 00000000..57212b66 --- /dev/null +++ b/docs/contribution/guidelines.mdx @@ -0,0 +1,4 @@ +--- +title: '📝 Guidelines' +url: https://github.com/embedchain/embedchain/blob/main/CONTRIBUTING.md +--- \ No newline at end of file diff --git a/docs/contribution/javascript.mdx b/docs/contribution/javascript.mdx new file mode 100644 index 00000000..02bcd5a4 --- /dev/null +++ b/docs/contribution/javascript.mdx @@ -0,0 +1,4 @@ +--- +title: '📝 Javascript' +url: https://github.com/embedchain/embedchain/tree/main/embedchain-js +--- \ No newline at end of file diff --git a/docs/contribution/python.mdx b/docs/contribution/python.mdx new file mode 100644 index 00000000..c682b3e4 --- /dev/null +++ b/docs/contribution/python.mdx @@ -0,0 +1,4 @@ +--- +title: '📝 Python' +url: https://github.com/embedchain/embedchain +--- \ No newline at end of file diff --git a/docs/mint.json b/docs/mint.json index ab2bb435..75ce0467 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -79,8 +79,14 @@ "pages": ["integration/langsmith"] }, { - "group": "Contribution Guidelines", - "pages": ["contribution/dev", "contribution/docs"] + "group": "Contribute", + "pages": [ + "contribution/guidelines", + "contribution/dev", + "contribution/docs", + "contribution/python", + "contribution/javascript" + ] } ],