update docs

diff --git a/README.md b/README.md
index 1613ee7fa8754a6c010592b06cfc7b6cfd3fa75e..934f755135f6ec8551293b93220f2355126bb730 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 [![PyPI](https://img.shields.io/pypi/v/waybacktweets)](https://pypi.org/project/waybacktweets)
 
-Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing, and saves the data.
+Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing, and saves the data in CSV, JSON, and HTML formats.
 
 ## Installation
 
@@ -44,8 +44,8 @@ archived_tweets = api.get()
 
 ## Documentation
 
-- [Wayback Tweets documentation]()
-- [Wayback CDX Server API - Beta documentation](https://archive.org/developers/wayback-cdx-server.html)
+- [Wayback Tweets documentation](https://claromes.github.io/waybacktweets)
+- [Wayback CDX Server API (Beta) documentation](https://archive.org/developers/wayback-cdx-server.html)
 
 ## Acknowledgements
 

diff --git a/app/app.py b/app/app.py
index 7a3821341e553ff4e2116acb202556888c828f92..5a8d8c9d13d6b169c41f4303f97ac215eaf6c21b 100644 (file)
--- a/app/app.py
+++ b/app/app.py
@@ -140,9 +140,9 @@ st.success(
     """**New Feature: CLI**
 
 You can now retrieve archived tweets using the Wayback Tweets command line tool.
-Download the archived tweets' CDX data in CSV, JSON, and HTML formats.
+Download the archived tweets CDX data in CSV, JSON, and HTML formats.
 
-For more details, [read the documentation](https://github.com/claromes/waybacktweets)."""  # noqa: E501
+For more details, [read the documentation](https://claromes.github.io/waybacktweets)."""  # noqa: E501
 )
 
 st.title(

diff --git a/docs/index.rst b/docs/index.rst
index b41345c47e6c43034792391d563f504b1d34c8c8..df486091b9c08a554f1ca8bbe72563b929e72939 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -7,7 +7,7 @@ Wayback Tweets
 Wayback Tweets Documentation
 ------------------------------
 
-Retrieves archived tweets' CDX data from the Wayback Machine, performs necessary parsing, and saves the data.
+Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing, and saves the data in CSV, JSON, and HTML formats.
 
 
 User Guide
@@ -22,6 +22,7 @@ User Guide
     result
     errors
     contribute
+    todo
 
 
 Command-Line Interface

diff --git a/docs/installation.rst b/docs/installation.rst
index 725f6c77032d129f1df560f4449ff8d4dd6f4249..e2df76b55774fe43b7a92e4047e514a9589e7f26 100644 (file)
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -37,4 +37,10 @@ From source
 
         poetry install
 
+    Run Streamlit App:
+
+    .. code-block:: shell
+
+        streamlit run app/app.py
+
 `Read the Poetry CLI documentation <https://python-poetry.org/docs/cli/>`_.

diff --git a/docs/todo.rst b/docs/todo.rst
new file mode 100644 (file)
index 0000000..4b2caa1
--- /dev/null
+++ b/docs/todo.rst
@@ -0,0 +1,9 @@
+TODO
+================
+
+.. |uncheck| raw:: html
+
+    <input type="checkbox">
+
+|uncheck| JSON Issue: Create a separate function to handle JSON return, apply JsonParser (``waybacktweets/api/parse_tweets.py:73``), and avoid rate limiting.
+

diff --git a/docs/workflow.rst b/docs/workflow.rst
index 2480b35c52ce0504c8ea0df8c8b56f6568599dc8..c3ffd321f672475400b94095c391a22488824b6e 100644 (file)
--- a/docs/workflow.rst
+++ b/docs/workflow.rst
@@ -19,5 +19,5 @@ Use the mouse to zoom in and out the flowchart.
       C--> |4xx| E[return None]
       E--> F{request Archived\nTweet URL}
       F--> |4xx| G[return Only CDX data]
-      F--> |2xx/3xx: application/json| J[return JSON text]
+      F--> |TODO: 2xx/3xx: application/json| J[return JSON text]
       F--> |2xx/3xx: text/html, warc/revisit, unk| K[return HTML iframe tag]