From 481217e500ff8e3d772467562454921b26c7adfa Mon Sep 17 00:00:00 2001 From: Elijas <4084885+Elijas@users.noreply.github.com> Date: Wed, 25 Oct 2023 18:01:24 +0300 Subject: [PATCH] docs: add Discord link --- CONTRIBUTING.md | 2 +- README.md | 4 ++-- dev_utils/debug_dashboard/app.py | 5 +++-- docs/source/notebooks/developer_guide.ipynb | 5 +++-- docs/source/notebooks/user_guide.ipynb | 5 +++-- 5 files changed, 12 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4685ed..89eec8d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,4 +22,4 @@ Before contributing, we highly recommend familiarizing yourself with these guide ## 🚧 Under Construction 🚧 > **Warning** -We're thrilled to inform you that the `sec-parser` project is the final prerequisite for launching our eagerly anticipated feature, sec-ai. We're diligently working to ensure that it meets all the necessary standards and functionalities.

Stay Informed: For detailed information and updates specific to `sec-parser` and to be the first to know when sec-ai is launched, please follow our Announcements page.

Contribute to sec-parser: If you're as excited about `sec-parser` and the upcoming sec-ai feature as we are, we warmly invite you to get involved!

- Please visit our Contribution Guide for sec-parser.
- Explore current Issues or propose new enhancements to `sec-parser`.

Our targeted launch for sec-ai is approaching, and we're grateful for your continued anticipation and interest, which are invaluable to our endeavors.
+We're thrilled to inform you that the `sec-parser` project is the final prerequisite for launching our eagerly anticipated feature, sec-ai. We're diligently working to ensure that it meets all the necessary standards and functionalities.

Stay Informed: For detailed information and updates specific to `sec-parser` and to be the first to know when sec-ai is launched, please follow our Announcements page.

Contribute to sec-parser: If you're as excited about `sec-parser` and the upcoming sec-ai feature as we are, we warmly invite you to get involved!

- Join our Discussions and connect with us on Discord.
- Please review our Contribution Guide for sec-parser.
- Explore the current Issues or propose new enhancements to the `sec-parser`.

Our targeted launch for sec-ai is approaching, and we're grateful for your continued anticipation and interest, which are invaluable to our endeavors.
diff --git a/README.md b/README.md index affe59a..2680fa9 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ See Demo | Read Docs | Join Discussions | - Report Bugs + Join Discord
@@ -78,7 +78,7 @@ pip install sec-ai ``` > **Warning** -We're thrilled to inform you that the `sec-parser` project is the final prerequisite for launching our eagerly anticipated feature, sec-ai. We're diligently working to ensure that it meets all the necessary standards and functionalities.

Stay Informed: For detailed information and updates specific to `sec-parser` and to be the first to know when sec-ai is launched, please follow our Announcements page.

Contribute to sec-parser: If you're as excited about `sec-parser` and the upcoming sec-ai feature as we are, we warmly invite you to get involved!

- Please visit our Contribution Guide for sec-parser.
- Explore current Issues or propose new enhancements to `sec-parser`.

Our targeted launch for sec-ai is approaching, and we're grateful for your continued anticipation and interest, which are invaluable to our endeavors.
+We're thrilled to inform you that the `sec-parser` project is the final prerequisite for launching our eagerly anticipated feature, sec-ai. We're diligently working to ensure that it meets all the necessary standards and functionalities.

Stay Informed: For detailed information and updates specific to `sec-parser` and to be the first to know when sec-ai is launched, please follow our Announcements page.

Contribute to sec-parser: If you're as excited about `sec-parser` and the upcoming sec-ai feature as we are, we warmly invite you to get involved!

- Join our Discussions and connect with us on Discord.
- Please review our Contribution Guide for sec-parser.
- Explore the current Issues or propose new enhancements to the `sec-parser`.

Our targeted launch for sec-ai is approaching, and we're grateful for your continued anticipation and interest, which are invaluable to our endeavors.
# Best Practices diff --git a/dev_utils/debug_dashboard/app.py b/dev_utils/debug_dashboard/app.py index b21e03b..b3ee142 100644 --- a/dev_utils/debug_dashboard/app.py +++ b/dev_utils/debug_dashboard/app.py @@ -45,8 +45,9 @@ **Contribute to sec-parser**: If you're as excited about `sec-parser` and the upcoming sec-ai feature as we are, we warmly invite you to get involved! - - Please visit our [Contribution Guide for sec-parser](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md). - - Explore [current Issues](https://github.com/alphanome-ai/sec-parser/issues) or propose new enhancements to `sec-parser`. + - Join our [Discussions](https://github.com/orgs/alphanome-ai/discussions) and connect with us on [Discord](https://discord.gg/w6bpyBW6). + - Please review our [Contribution Guide for sec-parser](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md). + - Explore the [current Issues](https://github.com/alphanome-ai/sec-parser/issues) or propose new enhancements to the `sec-parser`. Our targeted launch for sec-ai is approaching, and we're grateful for your continued anticipation and interest, which are invaluable to our endeavors. """, diff --git a/docs/source/notebooks/developer_guide.ipynb b/docs/source/notebooks/developer_guide.ipynb index e054d67..415a644 100644 --- a/docs/source/notebooks/developer_guide.ipynb +++ b/docs/source/notebooks/developer_guide.ipynb @@ -64,8 +64,9 @@ "\n", "**Contribute to sec-parser**: If you're as excited about `sec-parser` and the upcoming sec-ai feature as we are, we warmly invite you to get involved!\n", "\n", - " - Please visit our [Contribution Guide for sec-parser](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md).\n", - " - Explore [current Issues](https://github.com/alphanome-ai/sec-parser/issues) or propose new enhancements to `sec-parser`.\n", + " - Join our [Discussions](https://github.com/orgs/alphanome-ai/discussions) and connect with us on [Discord](https://discord.gg/w6bpyBW6).\n", + " - Please review our [Contribution Guide for sec-parser](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md).\n", + " - Explore the [current Issues](https://github.com/alphanome-ai/sec-parser/issues) or propose new enhancements to the `sec-parser`. \n", "\n", "Our targeted launch for sec-ai is approaching, and we're grateful for your continued anticipation and interest, which are invaluable to our endeavors." ] diff --git a/docs/source/notebooks/user_guide.ipynb b/docs/source/notebooks/user_guide.ipynb index 67a6f99..0fa0478 100644 --- a/docs/source/notebooks/user_guide.ipynb +++ b/docs/source/notebooks/user_guide.ipynb @@ -64,8 +64,9 @@ "\n", "**Contribute to sec-parser**: If you're as excited about `sec-parser` and the upcoming sec-ai feature as we are, we warmly invite you to get involved!\n", "\n", - " - Please visit our [Contribution Guide for sec-parser](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md).\n", - " - Explore [current Issues](https://github.com/alphanome-ai/sec-parser/issues) or propose new enhancements to `sec-parser`.\n", + " - Join our [Discussions](https://github.com/orgs/alphanome-ai/discussions) and connect with us on [Discord](https://discord.gg/w6bpyBW6).\n", + " - Please review our [Contribution Guide for sec-parser](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md).\n", + " - Explore the [current Issues](https://github.com/alphanome-ai/sec-parser/issues) or propose new enhancements to the `sec-parser`. \n", "\n", "Our targeted launch for sec-ai is approaching, and we're grateful for your continued anticipation and interest, which are invaluable to our endeavors." ]