Skip to content

Commit d3fb6f8

Browse files
committed
docs: update doc homepage
1 parent d2bdb64 commit d3fb6f8

File tree

1 file changed

+29
-19
lines changed

1 file changed

+29
-19
lines changed

docs/index.rst

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,23 @@ Zarr-Python
99
:hidden:
1010

1111
quickstart
12+
about
1213
user-guide/index
1314
api/index
14-
release
15-
contributing
16-
roadmap
17-
installation
15+
developers/index
16+
developers/release
1817

1918
**Version**: |version|
2019

21-
**Download documentation**: `PDF/Zipped HTML <https://readthedocs.org/projects/zarr/downloads/>`_
22-
23-
**Useful links**:
24-
`Installation <installation.html>`_ |
25-
`Source Repository <https://github.com/zarr-developers/zarr-python>`_ |
26-
`Issue Tracker <https://github.com/zarr-developers/zarr-python/issues>`_ |
27-
`Zulip Chat <https://ossci.zulipchat.com/>`_ |
28-
`Zarr specifications <https://zarr-specs.readthedocs.io>`_
20+
Zarr is a storage format for chunked, compressed, N-dimensional arrays based on an open-source specification. Highlights include:
2921

30-
Zarr is a file storage format for chunked, compressed, N-dimensional arrays based on an open-source specification.
22+
* Create N-dimensional arrays with any NumPy dtype.
23+
* Chunk arrays along any dimension.
24+
* Compress and/or filter chunks using any NumCodecs_ codec.
25+
* Store arrays in memory, on disk, inside a Zip file, on S3, ...
26+
* Read an array concurrently from multiple threads or processes.
27+
* Write to an array concurrently from multiple threads or processes.
28+
* Organize arrays into hierarchies via groups.
3129

3230
.. grid:: 2
3331

@@ -85,21 +83,33 @@ Zarr is a file storage format for chunked, compressed, N-dimensional arrays base
8583
:color: dark
8684
:click-parent:
8785

88-
To the api reference guide
86+
To the API reference guide
8987

9088
.. grid-item-card::
9189
:img-top: _static/index_contribute.svg
9290

93-
Contributor's Guide
94-
^^^^^^^^^^^^^^^^^^^
91+
Developer's Guide
92+
^^^^^^^^^^^^^^^^^
9593

96-
Want to contribute to Zarr? We welcome contributions in the form of bug reports, bug fixes, documentation, enhancement proposals and more. The contributing guidelines will guide you through the process of improving Zarr.
94+
Want to contribute to Zarr? We welcome contributions in the form of bug reports,
95+
bug fixes, documentation, enhancement proposals and more. The contributing
96+
guidelines will guide you through the process of improving Zarr.
9797

9898
+++
9999

100-
.. button-ref:: contributing
100+
.. button-ref:: developers/index
101101
:expand:
102102
:color: dark
103103
:click-parent:
104104

105-
To the contributor's guide
105+
To the developers's guide
106+
107+
**Useful links**:
108+
`Source Repository <https://github.com/zarr-developers/zarr-python>`_ |
109+
`Issue Tracker <https://github.com/zarr-developers/zarr-python/issues>`_ |
110+
`Zulip Chat <https://ossci.zulipchat.com/>`_ |
111+
`Zarr specifications <https://zarr-specs.readthedocs.io>`_
112+
113+
**Download documentation**: `PDF/Zipped HTML <https://readthedocs.org/projects/zarr/downloads/>`_
114+
115+
.. _NumCodecs: https://numcodecs.readthedocs.io

0 commit comments

Comments
 (0)