Skip to content

Commit

Permalink
docs: rename notebooks
Browse files Browse the repository at this point in the history
  • Loading branch information
Elijas committed Oct 13, 2023
1 parent 0c62930 commit 76a1f1f
Showing 4 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -78,16 +78,16 @@ import sec_ai as sa
# TODO: Examples are coming soon!
```

For more examples and advanced usage, you can continue learning how to use sec-ai by referring to the [**Quickstart User Guide**](https://sec-ai.readthedocs.io/en/latest/notebooks/quickstart_user_guide.html).
For more examples and advanced usage, you can continue learning how to use sec-ai by referring to the [**Quickstart User Guide**](https://sec-ai.readthedocs.io/en/latest/notebooks/user_guide.html).


# Contributing

Contributing to `sec-ai` is a rewarding way to improve this open-source project. Whether you are a user interested in expanding your knowledge or a developer who wants to dive deeper into the codebase, we have comprehensive guides to get you started.

- **User Guide**: If you are new to `sec-ai` and would like to get started, please refer to the [**Quickstart User Guide**](https://sec-ai.readthedocs.io/en/latest/notebooks/quickstart_user_guide.html).
- **User Guide**: If you are new to `sec-ai` and would like to get started, please refer to the [**Quickstart User Guide**](https://sec-ai.readthedocs.io/en/latest/notebooks/user_guide.html).

- **Developer Guide**: For those interested in contributing to `sec-ai`, the [**Comprehensive Developer Guide**](https://sec-ai.readthedocs.io/en/latest/notebooks/comprehensive_developer_guide.html) provides an in-depth walkthrough of the codebase and offers examples to help you contribute effectively.
- **Developer Guide**: For those interested in contributing to `sec-ai`, the [**Comprehensive Developer Guide**](https://sec-ai.readthedocs.io/en/latest/notebooks/developer_guide.html) provides an in-depth walkthrough of the codebase and offers examples to help you contribute effectively.

Both guides are interactive and allow you to engage with the code and concepts as you learn. You can run and modify all the code examples for yourself by cloning the repository and running the respective notebooks in a Jupyter environment.

4 changes: 2 additions & 2 deletions docs/source/index.md
Original file line number Diff line number Diff line change
@@ -12,8 +12,8 @@
:caption: 'Contents:'
:maxdepth: 2
notebooks/quickstart_user_guide
notebooks/comprehensive_developer_guide
notebooks/user_guide
notebooks/developer_guide
```

<hr>
Original file line number Diff line number Diff line change
@@ -46,7 +46,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Comprehensive Developer Guide"
"# Developer Guide: Comprehensive Overview"
]
},
{
@@ -56,12 +56,12 @@
"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 [comprehensive_developer_guide.ipynb](https://github.com/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/comprehensive_developer_guide.ipynb) in a Jupyter notebook. \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/comprehensive_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/comprehensive_developer_guide.ipynb)\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!"
]
Original file line number Diff line number Diff line change
@@ -46,7 +46,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Quickstart User Guide"
"# User Guide: Quick Start"
]
},
{
@@ -56,12 +56,12 @@
"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 [quickstart_user_guide.ipynb](https://github.com/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/quickstart_user_guide.ipynb) in a Jupyter notebook.\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/quickstart_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/quickstart_user_guide.ipynb)\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!"
]

0 comments on commit 76a1f1f

Please sign in to comment.