add admonitions about early development (#38)

conda-incubator · Jun 19, 2024 · 0d46ba8 · 0d46ba8
1 parent 590900a
commit 0d46ba8
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,6 +2,10 @@
 
 Better PyPI interoperability for the conda ecosystem.
 
+> [!IMPORTANT]
+> This project is still in early stages of development. Don't use it in production (yet).
+> We do welcome feedback on what the expected behaviour should have been if something doesn't work!
+
 ## What is this?
 
 Includes:

diff --git a/docs/index.md b/docs/index.md
@@ -5,6 +5,11 @@ Welcome to the `conda-pypi` documentation!
 `conda-pypi` allows you to run `conda pip install ...` in a safe way, and many other things.
 
 
+:::{warning}
+This project is still in early stages of development. Don't use it in production (yet).
+We do welcome feedback on what the expected behaviour should have been if something doesn't work!
+:::
+
 ::::{grid} 2
 
 :::{grid-item-card} 🏡 Getting started
@@ -18,6 +23,9 @@ New to `conda-pypi`? Start here to learn the essentials
 :link-type: doc
 Read about why `conda-pypi` exists and when you should use it
 :::
+::::
+
+::::{grid} 2
 
 :::{grid-item-card} 🍱 Features
 :link: features

diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -94,6 +94,6 @@ https://conda.anaconda.org/conda-forge/noarch/pip-24.0-pyhd8ed1ab_0.conda#f586ac
 
 - The `base` environment.
 - All new environments that include `pip`.
-- Existing environments that `pip`, but only after running a conda command on them.
+- Existing environments that already have `pip`, but only after running a conda command on them.
 
 More details at {ref}`externally-managed`.