Skip to content

Commit a479ded

Browse files
authored
Add notes about current development status and breaking changes (#93)
1 parent 528a770 commit a479ded

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ Many components of this chat project come from [jupyter-ai](https://github.com/j
1010

1111
![a screenshot showing the jupyter-chat extension used in two browser windows](https://github.com/jupyterlab/jupyter-chat/assets/591645/5dac0b00-43ed-4458-ab67-18207644b92b)
1212

13+
> **Warning**
14+
>
15+
> This project is still in early development stage and its API may change often before
16+
a stable release.
17+
1318
## Composition
1419

1520
### Typescript package

docs/source/developers/index.md

+5
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ This section is aimed at developers and contains documentation on :
55
- how to develop a chat extension or include one of the chat extensions
66
- how to contribute to this project
77

8+
```{warning}
9+
This project is still in early development stage and its API may change often before a
10+
stable release.
11+
```
12+
813
```{toctree}
914
---
1015
maxdepth: 2

0 commit comments

Comments
 (0)