simplify main doc page

- Simplify explanation from docs to README (to be fully updated later)
afids · Jul 31, 2023 · 2e366ae · 2e366ae
1 parent 16f3eac
commit 2e366ae
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,8 @@
 # Anatomical Fiducials (AFIDs) Utility Tools
 
-[![Documentation Status](https://readthedocs.org/projects/afids-utils/badge/?version=latest)](https://afids-utils.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status](https://readthedocs.org/projects/afids-utils/badge/?version=latest)](https://afids-utils.readthedocs.io/en/latest/?badge=latest)
+
+The `afids_utils` package provides common utilities for projects involving 
+anatomical fiducials (AFIDs). Some key functionalities offered include. For a
+comprehensive list of available utilities refer to the 
+[documentation](https://afids-utils.readthedocs.io/en/stable) page.
diff --git a/docs/general/main.md b/docs/general/main.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,15 +1,6 @@
 ```{include} ../README.md
 ```
 
-```{toctree}
-:caption: General
-:name: general
-:hidden:
-:maxdepth: 2
-
-general/main
-```
-
 ```{toctree}
 :caption: API Reference
 :name: api_reference