Skip to content

Commit cd30621

Browse files
yue-herejdbocarslyml-evs
authored
Improve and restructure README, plus other minor docs fixes (#1245)
Co-authored-by: Josh Bocarsly <[email protected]> Co-authored-by: Matthew Evans <[email protected]>
1 parent 18ee71c commit cd30621

File tree

8 files changed

+302
-242
lines changed

8 files changed

+302
-242
lines changed

CHANGELOG.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Changelog
22

3-
## v0.6.0 (June 2025)
3+
## v0.6.0 (July 2025)
44

5-
This release includes significant new functionality and UI redesign, as well as
6-
several bug and quality-of-life fixes, performance improvements and
7-
backwards-compatible API enhancements.
5+
This release includes significant new functionality and UI redesign, a
6+
fledgling plugin ecosystem, as well as several bug and quality-of-life
7+
fixes, performance improvements and backwards-compatible API enhancements.
88

99
> [!WARNING]
1010
> This release also bumps the supported MongoDB version all the way from v3 to v8. Whilst older MongoDB versions should still continue to work, version 8 will now be tested and used in the docker builds, so we recommend you upgrade. For existing databases this requires you to first dump the database using `mongodump` with the old MongoDB version, then upgrade to the new version and restore the database with `mongorestore`. If you unsure about this process then please ask us for help!
@@ -23,10 +23,14 @@ backwards-compatible API enhancements.
2323
[`datalab-app-plugin-insitu`](https://github.com/datalab-org/datalab-app-plugin-insitu)),
2424
as well as new file formats supported in the XRD (Rigaku's .rasx, variants of .xy), NMR (JCAMP-DX) blocks
2525
and media block (PDF documents).
26+
- A fledgling plugin ecosystem with ways to easily add new blocks to a specific
27+
*datalab* instance ([docs](https://docs.datalab-org.io/en/v0.6.0/plugins/)).
2628
- Improved item search throughout the API, removing the need to search on
27-
whitespace or puncutation delimited words (e.g., ID matches will now begin after
29+
whitespace or punctuation delimited words (e.g., ID matches will now begin after
2830
just 3 characters, rather than needing to type a full ID).
31+
- More powerful UI block interactions via "events" that can be written purely Python ([docs](https://docs.datalab-org.io/en/v0.6.0/blocks/)).
2932

33+
**Full Changelog**: https://github.com/datalab-org/datalab/compare/v0.5.2...v0.6.0
3034

3135
## v0.5.2 (March 2025)
3236

@@ -70,7 +74,7 @@ Many thanks to all contributors: developers, user feedback and deployment manage
7074

7175
## Breaking changes
7276

73-
* The Python server has been entirely repackaged with `uv` for much more streamlined dependency management (especially for external plugins). If you are using the docker deployments, then nothing should change for you, but developers may need to adjust their development setups following the instructions at [INSTALL.md](./INSTALL.md)
77+
* The Python server has been entirely repackaged with `uv` for much more streamlined dependency management (especially for external plugins). If you are using the docker deployments, then nothing should change for you, but developers may need to adjust their development setups following the [installation instructions](./INSTALL.md).
7478

7579
## Highlights
7680

INSTALL.md

Lines changed: 0 additions & 183 deletions
This file was deleted.

0 commit comments

Comments
 (0)