doc tweaks

johnkerl · Sep 10, 2023 · 03eed30 · 03eed30
1 parent 268a96d
commit 03eed30
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/docs/src/miller-as-library.md b/docs/src/miller-as-library.md
@@ -19,6 +19,11 @@ Quick links:
 Very initially and experimentally, as of Miller 6.9.1, Go developers will be able to access Miller source
 code --- moved from `internal/pkg/` to `pkg/` --- within their own Go projects.
 
+Caveat emptor: Miller's backward-compatibility guarantees are at the CLI level; API is not guaranteed stable.
+For this reason, please be careful with your version pins.
+
+I'm happy to discuss this new area further at the [discussions page](https://github.com/johnkerl/miller/discussions).
+
 ## Setup
 
 ```

diff --git a/docs/src/miller-as-library.md.in b/docs/src/miller-as-library.md.in
@@ -3,6 +3,11 @@
 Very initially and experimentally, as of Miller 6.9.1, Go developers will be able to access Miller source
 code --- moved from `internal/pkg/` to `pkg/` --- within their own Go projects.
 
+Caveat emptor: Miller's backward-compatibility guarantees are at the CLI level; API is not guaranteed stable.
+For this reason, please be careful with your version pins.
+
+I'm happy to discuss this new area further at the [discussions page](https://github.com/johnkerl/miller/discussions).
+
 ## Setup
 
 ```

diff --git a/docs/src/release-docs.md b/docs/src/release-docs.md
@@ -23,6 +23,7 @@ If your `mlr version` says something like `Miller v5.10.2` or `mlr 6.0.0`, witho
 
 | Release | Docs                                                                | Release notes |
 |---------|---------------------------------------------------------------------|---------------|
+main      | [main branch](https://miller.readthedocs.io/en/main)                | N/A |
 6.8.0     | [Miller 6.8.0](https://miller.readthedocs.io/en/6.8.0)              | [New case verb, index DSL function, and more](https://github.com/johnkerl/miller/releases/tag/v6.8.0) |
 6.7.0     | [Miller 6.7.0](https://miller.readthedocs.io/en/6.7.0)              | [New leftpad/rightpad DSL functions, unspace verb, and more](https://github.com/johnkerl/miller/releases/tag/v6.7.0) |
 6.6.0     | [Miller 6.6.0](https://miller.readthedocs.io/en/6.6.0)              | [Bugfixes and unspace verb](https://github.com/johnkerl/miller/releases/tag/v6.6.0) |

diff --git a/docs/src/release-docs.md.in b/docs/src/release-docs.md.in
@@ -7,6 +7,7 @@ If your `mlr version` says something like `Miller v5.10.2` or `mlr 6.0.0`, witho
 
 | Release | Docs                                                                | Release notes |
 |---------|---------------------------------------------------------------------|---------------|
+main      | [main branch](https://miller.readthedocs.io/en/main)                | N/A |
 6.8.0     | [Miller 6.8.0](https://miller.readthedocs.io/en/6.8.0)              | [New case verb, index DSL function, and more](https://github.com/johnkerl/miller/releases/tag/v6.8.0) |
 6.7.0     | [Miller 6.7.0](https://miller.readthedocs.io/en/6.7.0)              | [New leftpad/rightpad DSL functions, unspace verb, and more](https://github.com/johnkerl/miller/releases/tag/v6.7.0) |
 6.6.0     | [Miller 6.6.0](https://miller.readthedocs.io/en/6.6.0)              | [Bugfixes and unspace verb](https://github.com/johnkerl/miller/releases/tag/v6.6.0) |