Skip to content

Commit

Permalink
docs: improve 'under construction' message
Browse files Browse the repository at this point in the history
  • Loading branch information
Elijas committed Oct 15, 2023
1 parent a62cf8c commit c891c92
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 49 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,8 @@ pip install sec-ai
```

> **Warning**
We are currently finalizing a few key prerequisites for `sec-ai` within our [**sec-parser**](https://github.com/alphanome-ai/sec-parser) project, as detailed in our [**Roadmap**](https://github.com/orgs/alphanome-ai/discussions/categories/roadmap-future-plans).<br><br>Your anticipation for the launch of `sec-ai` is greatly appreciated. We are working diligently to ensure that `sec-ai` is ready to launch as soon as possible. To stay informed about our progress and to receive notifications when `sec-ai` is ready, please follow our [**Announcements**](https://github.com/orgs/alphanome-ai/discussions/categories/announcements) page.<br><br>**Get Involved**: If you're excited about our project and would like to contribute, we warmly invite you to do so! Check out our [**sec-parser/CONTRIBUTING.md**](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md) guide for details on how to get started.
<br><br>Thank you for your interest and we look forward to sharing our progress with you soon.
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.<br><br><b>Stay Informed:</b> For detailed information and updates specific to `sec-parser` and to be the first to know when sec-ai is launched, please <a href="https://github.com/orgs/alphanome-ai/discussions/categories/announcements">follow our Announcements page</a>.<br><br><b>Contribute to sec-parser:</b> If you're as excited about `sec-parser` and the upcoming sec-ai feature as we are, we warmly invite you to get involved!<br><br>- Please visit our <a href="https://github.com/alphanome-ai/sec-ai/blob/main/CONTRIBUTING.md">Contribution Guide for sec-parser</a>.<br>- Explore <a href="https://github.com/alphanome-ai/sec-parser/issues">current Issues</a> or propose new enhancements to `sec-parser`.<br><br>Our targeted launch for sec-ai is approaching, and we're grateful for your continued anticipation and interest, which are invaluable to our endeavors.<br>
For more examples and advanced usage, you can continue learning how to use `sec-ai` by referring to the [**User Guide**](https://sec-ai.readthedocs.io/en/latest/notebooks/user_guide.html), [**Developer Guide**](https://sec-ai.readthedocs.io/en/latest/notebooks/developer_guide.html), and [**Documentation**](https://sec-ai.rtfd.io).

# Best Practices

Expand Down
4 changes: 4 additions & 0 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,7 @@ tasks:
m: # You can just run `task m` instead of `task monitor-unit-tests`.
deps:
- monitor-unit-tests

x: # You can just run `task l` instead of `task launch-docs`.
deps:
- launch-docs
11 changes: 7 additions & 4 deletions dev_utils/debug_dashboard/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,16 @@
st.info(
"""
### 🚧 Under Construction 🚧
We are currently finalizing a few key prerequisites for `sec-ai` within our [**sec-parser**](https://github.com/alphanome-ai/sec-parser) project, as detailed in our [**Roadmap**](https://github.com/orgs/alphanome-ai/discussions/categories/roadmap-future-plans).
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.
Your anticipation for the launch of `sec-ai` is greatly appreciated. We are working diligently to ensure that `sec-ai` is ready to launch as soon as possible. To stay informed about our progress and to receive notifications when `sec-ai` is ready, please follow our [**Announcements**](https://github.com/orgs/alphanome-ai/discussions/categories/announcements) page.
**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](https://github.com/orgs/alphanome-ai/discussions/categories/announcements).
**Get Involved**: If you're excited about our project and would like to contribute, we warmly invite you to do so! Check out our [**sec-parser/CONTRIBUTING.md**](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md) guide for details on how to get started.
**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!
Thank you for your interest and we look forward to sharing our progress with you soon.
- Please visit our [Contribution Guide for sec-parser](https://github.com/alphanome-ai/sec-ai/blob/main/CONTRIBUTING.md).
- Explore [current Issues](https://github.com/alphanome-ai/sec-parser/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.
""",
)
else:
Expand Down
28 changes: 7 additions & 21 deletions docs/source/notebooks/developer_guide.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -52,36 +52,22 @@
"# Developer Guide: Comprehensive Overview"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"Welcome to the Comprehensive Developer Guide for `sec-ai`. This guide is designed to provide an in-depth understanding of the `sec-ai` project, whether you're a new developer looking to contribute, or an experienced one seeking to leverage its capabilities. We'll walk you through the codebase, explaining key components and their interactions, and provide examples to help you get started. \n",
"\n",
"This guide is interactive, allowing you to engage with the code and concepts as you learn. You can run and modify all the code examples shown here for yourself by cloning the repository and running the [developer_guide.ipynb](https://github.com/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/developer_guide.ipynb) in a Jupyter notebook. \n",
"\n",
"Alternatively, you can also run the notebook directly in your browser using Google Colab:\n",
"\n",
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/developer_guide.ipynb)\n",
"[![My Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/alphanome-ai/sec-ai/main?filepath=docs/source/notebooks/developer_guide.ipynb)\n",
"\n",
"Let's dive in!"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## 🚧 Under Construction 🚧\n",
"We are currently finalizing a few key prerequisites for `sec-ai` within our [**sec-parser**](https://github.com/alphanome-ai/sec-parser) project, as detailed in our [**Roadmap**](https://github.com/orgs/alphanome-ai/discussions/categories/roadmap-future-plans).\n",
"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.\n",
"\n",
"**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](https://github.com/orgs/alphanome-ai/discussions/categories/announcements).\n",
"\n",
"Your anticipation for the launch of `sec-ai` is greatly appreciated. We are working diligently to ensure that `sec-ai` is ready to launch as soon as possible. To stay informed about our progress and to receive notifications when `sec-ai` is ready, please follow our [**Announcements**](https://github.com/orgs/alphanome-ai/discussions/categories/announcements) page.\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",
"**Get Involved**: If you're excited about our project and would like to contribute, we warmly invite you to do so! Check out our [**sec-parser/CONTRIBUTING.md**](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md) guide for details on how to get started.\n",
" - Please visit our [Contribution Guide for sec-parser](https://github.com/alphanome-ai/sec-ai/blob/main/CONTRIBUTING.md).\n",
" - Explore [current Issues](https://github.com/alphanome-ai/sec-parser/issues) or propose new enhancements to `sec-parser`.\n",
"\n",
"Thank you for your interest and we look forward to sharing our progress with you soon."
"Our targeted launch for sec-ai is approaching, and we're grateful for your continued anticipation and interest, which are invaluable to our endeavors."
]
}
],
Expand Down
28 changes: 7 additions & 21 deletions docs/source/notebooks/user_guide.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -52,36 +52,22 @@
"# User Guide: Quick Start"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"Welcome to the Quickstart User Guide for `sec-ai`! This guide is designed to walk you through the fundamental steps needed to install and use the library for using the comprehensive toolset for analyzing and interpreting data from SEC filings. Whether you're a financial analyst, a data scientist, or someone interested in SEC filings, this guide provides examples and code snippets to help you get started.\n",
"\n",
"This guide is interactive, allowing you to engage with the code and concepts as you learn. You can run and modify all the code examples shown here for yourself by cloning the repository and running the [user_guide.ipynb](https://github.com/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/user_guide.ipynb) in a Jupyter notebook.\n",
"\n",
"Alternatively, you can also run the notebook directly in your browser using Google Colab:\n",
"\n",
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/user_guide.ipynb)\n",
"[![My Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/alphanome-ai/sec-ai/main?filepath=docs/source/notebooks/user_guide.ipynb)\n",
"\n",
"Let's get started!"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## 🚧 Under Construction 🚧\n",
"We are currently finalizing a few key prerequisites for `sec-ai` within our [**sec-parser**](https://github.com/alphanome-ai/sec-parser) project, as detailed in our [**Roadmap**](https://github.com/orgs/alphanome-ai/discussions/categories/roadmap-future-plans).\n",
"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.\n",
"\n",
"**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](https://github.com/orgs/alphanome-ai/discussions/categories/announcements).\n",
"\n",
"Your anticipation for the launch of `sec-ai` is greatly appreciated. We are working diligently to ensure that `sec-ai` is ready to launch as soon as possible. To stay informed about our progress and to receive notifications when `sec-ai` is ready, please follow our [**Announcements**](https://github.com/orgs/alphanome-ai/discussions/categories/announcements) page.\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",
"**Get Involved**: If you're excited about our project and would like to contribute, we warmly invite you to do so! Check out our [**sec-parser/CONTRIBUTING.md**](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md) guide for details on how to get started.\n",
" - Please visit our [Contribution Guide for sec-parser](https://github.com/alphanome-ai/sec-ai/blob/main/CONTRIBUTING.md).\n",
" - Explore [current Issues](https://github.com/alphanome-ai/sec-parser/issues) or propose new enhancements to `sec-parser`.\n",
"\n",
"Thank you for your interest and we look forward to sharing our progress with you soon."
"Our targeted launch for sec-ai is approaching, and we're grateful for your continued anticipation and interest, which are invaluable to our endeavors."
]
}
],
Expand Down

0 comments on commit c891c92

Please sign in to comment.