From 9a7bea6e55d1e997e27b80533643f3ca2c07e784 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Gr=C3=BCter?= Date: Sat, 10 Jan 2026 16:33:45 +0100 Subject: [PATCH 1/2] Update README after merging contributing guide --- README.md | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 466c076..8642372 100644 --- a/README.md +++ b/README.md @@ -13,27 +13,19 @@ Docstub aims to take advantage of these and help with the adoption of type annot It does so by supporting widely used readable conventions such as `array of dtype` or `iterable of int(s)` which are translated into valid type annotations. -## Installation & getting started +## Getting started & quick links -Please refer to the installation guide and introduction in our [official documentation](https://docstub.readthedocs.io/) or in [docs/](docs/) to get started. +- [Documentation](https://docstub.readthedocs.io/) (see also [docs/](docs/)) +Specific guides: -## Contributing +- [Installation](https://docstub.readthedocs.io/stable/installation.html) +- [Introduction](https://docstub.readthedocs.io/stable/introduction.html) +- [Contributing](https://docstub.readthedocs.io/latest/development/contributing.html) -The best way you can help and contribute right now is by trying docstub out! -Feedback to what features might still be missing or where it breaks for you would be greatly appreciated. -As well as pointers to where the documentation is confusing and unclear. -Feel welcome to [open an issue](https://github.com/scientific-python/docstub/issues/new/choose)! 🚀 +Our [release notes](https://docstub.readthedocs.io/latest/release_notes/index.html) are in [docs/release_notes/](docs/release_notes). -Since docstub is still in early development there isn't an official contribution guide yet. -Features and API are still being heavily extended and the internal structure is still somewhat in flux. -The development is, in part, motivated by an effort to add type annotations to the [scikit-image project](https://scikit-image.org). -This may inform some short-term priorities and the roadmap. - -That said, docstub is a project for the community and welcomes contributions in any form! -Please do check in with an issue if you are interested in working on something. - -Our project follows the [Scientific Python's Code of Conduct](https://scientific-python.org/code_of_conduct/). +Our project follows [Scientific Python's Code of Conduct](https://scientific-python.org/code_of_conduct/). ## Acknowledgements From faa4735d42294e7aafef648db9854dac6ba24eb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Gr=C3=BCter?= Date: Mon, 19 Jan 2026 14:50:49 +0100 Subject: [PATCH 2/2] Note link to stable or latest docs --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8642372..619b75e 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,11 @@ It does so by supporting widely used readable conventions such as `array of dtyp Specific guides: -- [Installation](https://docstub.readthedocs.io/stable/installation.html) -- [Introduction](https://docstub.readthedocs.io/stable/introduction.html) -- [Contributing](https://docstub.readthedocs.io/latest/development/contributing.html) +- [Installation (stable)](https://docstub.readthedocs.io/stable/installation.html) +- [Introduction (stable)](https://docstub.readthedocs.io/stable/introduction.html) +- [Contributing (latest)](https://docstub.readthedocs.io/latest/development/contributing.html) -Our [release notes](https://docstub.readthedocs.io/latest/release_notes/index.html) are in [docs/release_notes/](docs/release_notes). +Our [release notes (latest)](https://docstub.readthedocs.io/latest/release_notes/index.html) are in [docs/release_notes/](docs/release_notes). Our project follows [Scientific Python's Code of Conduct](https://scientific-python.org/code_of_conduct/).