docs: update doc homepage (#2594)

* docs: split tutorial into multiple user guide sections

* docs: replace getting_started page with quickstart

* docs: update installation docs

* docs: update doc homepage

* fixups

* fix ref to contributing guide

* fixup

Author: jhamman

docs/api/index.rst

@@ -1,4 +1,4 @@
-API Reference
+API reference
 =============
 
 .. toctree::

docs/conf.py

@@ -107,6 +107,7 @@ def skip_submodules(
      "getting-started": "quickstart",
      "release": "developers/release.html",
      "roadmap": "developers/roadmap.html",
+     "installation": "user-guide/installation.html",
 }
 
 # The language for content autogenerated by Sphinx. Refer to documentation

docs/developers/contributing.rst

@@ -1,3 +1,5 @@
+.. _dev-guide-contributing:
+
 Contributing to Zarr
 ====================
 

docs/index.rst

@@ -9,7 +9,6 @@ Zarr-Python
     :hidden:
 
     quickstart
-    installation
     user-guide/index
     api/index
     developers/index
@@ -18,16 +17,19 @@ Zarr-Python
 
 **Version**: |version|
 
-**Download documentation**: `PDF/Zipped HTML <https://readthedocs.org/projects/zarr/downloads/>`_
-
 **Useful links**:
-`Installation <installation.html>`_ |
 `Source Repository <https://github.com/zarr-developers/zarr-python>`_ |
 `Issue Tracker <https://github.com/zarr-developers/zarr-python/issues>`_ |
 `Zulip Chat <https://ossci.zulipchat.com/>`_ |
 `Zarr specifications <https://zarr-specs.readthedocs.io>`_
 
-Zarr is a file storage format for chunked, compressed, N-dimensional arrays based on an open-source specification.
+Zarr-Python is a Python library for reading and writing Zarr groups and arrays. Highlights include:
+
+* Specification support for both Zarr v2 and v3.
+* Create and read from N-dimensional arrays using NumPy-like semantics.
+* Flexible storage enables reading and writing from local, cloud and in-memory stores.
+* High performance: Enables fast I/O with support for asynchronous I/O and multi-threading.
+* Extensible: Customizable with user-defined codecs and stores.
 
 .. grid:: 2
 
@@ -84,7 +86,7 @@ Zarr is a file storage format for chunked, compressed, N-dimensional arrays base
             :color: dark
             :click-parent:
 
-            To the api reference guide
+            To the API reference guide
 
     .. grid-item-card::
         :img-top: _static/index_contribute.svg
@@ -104,3 +106,8 @@ Zarr is a file storage format for chunked, compressed, N-dimensional arrays base
             :click-parent:
 
             To the contributor's guide
+
+
+**Download documentation**: `PDF/Zipped HTML <https://readthedocs.org/projects/zarr/downloads/>`_
+
+.. _NumCodecs: https://numcodecs.readthedocs.io

docs/installation.rst

@@ -6,16 +6,14 @@ User guide
 .. toctree::
     :maxdepth: 1
 
+    installation
     arrays
     groups
     attributes
     storage
     config
     v3_migration
 
-.. Coming soon
-    installation
-
 Advanced Topics
 ---------------
 

docs/user-guide/index.rst

@@ -0,0 +1,54 @@
+Installation
+============
+
+Required dependencies
+---------------------
+
+Required dependencies include:
+
+- `Python <https://docs.python.org/3/>`_ (3.11 or later)
+- `packaging <https://packaging.pypa.io>`_ (22.0 or later)
+- `numpy <https://numpy.org>`_ (1.25 or later)
+- `numcodecs[crc32c] <https://numcodecs.readthedocs.io>`_ (0.14 or later)
+- `typing_extensions <https://typing-extensions.readthedocs.io>`_ (4.9 or later)
+- `donfig <https://donfig.readthedocs.io>`_ (0.8 or later)
+
+pip
+---
+
+Zarr is available on `PyPI <https://pypi.org/project/zarr/>`_. Install it using ``pip``:
+
+.. code-block:: console
+
+    $ pip install zarr
+
+There are a number of optional dependency groups you can install for extra functionality.
+These can be installed using ``pip install "zarr[<extra>]"``, e.g. ``pip install "zarr[gpu]"``
+
+- ``gpu``: support for GPUs
+- ``remote``: support for reading/writing to remote data stores
+
+Additional optional dependencies include ``rich``, ``universal_pathlib``. These must be installed separately.
+
+conda
+-----
+
+Zarr is also published to `conda-forge <https://conda-forge.org>`_. Install it using ``conda``:
+
+.. code-block:: console
+
+    $ conda install -c conda-forge zarr
+
+Conda does not support optional dependencies, so you will have to manually install any packages
+needed to enable extra functionality.
+
+Dependency support
+------------------
+Zarr has endorsed `Scientific-Python SPEC 0 <https://scientific-python.org/specs/spec-0000/>`_ and now follows the version support window as outlined below:
+
+- Python: 36 months after initial release
+- Core package dependencies (e.g. NumPy): 24 months after initial release
+
+Development
+-----------
+To install the latest development version of Zarr, see the :ref:`contributing guide <dev-guide-contributing>`.