From 3971d3412dddd794cbeeb99342d63329793effc1 Mon Sep 17 00:00:00 2001 From: Efthymis Sarmpanis Date: Thu, 4 Jan 2024 17:32:09 +0200 Subject: [PATCH] feat(doc): merge version policy and choose package pages into an Installation page --- .../{choose_package.mdx => installation.mdx} | 19 +++++++++++++++++- .../Flutter/01-basics/versioning_policy.mdx | 20 ------------------- 2 files changed, 18 insertions(+), 21 deletions(-) rename docusaurus/docs/Flutter/01-basics/{choose_package.mdx => installation.mdx} (68%) delete mode 100644 docusaurus/docs/Flutter/01-basics/versioning_policy.mdx diff --git a/docusaurus/docs/Flutter/01-basics/choose_package.mdx b/docusaurus/docs/Flutter/01-basics/installation.mdx similarity index 68% rename from docusaurus/docs/Flutter/01-basics/choose_package.mdx rename to docusaurus/docs/Flutter/01-basics/installation.mdx index a192676ae..e32636fab 100644 --- a/docusaurus/docs/Flutter/01-basics/choose_package.mdx +++ b/docusaurus/docs/Flutter/01-basics/installation.mdx @@ -1,5 +1,5 @@ --- -id: choose_package +id: installation sidebar_position: 2 title: Installation --- @@ -55,3 +55,20 @@ and architecture. Summary: For the most control over the SDK and dealing with low level calls to the API, use `stream_chat`. + +### Versioning Policy + +All of the Stream Chat packages follow [semantic versioning](https://semver.org/). + +That means that with a version number x.y.z (major.minor.patch): +- When releasing bug fixes (backwards compatible), we make a patch release by changing the z number (ex: 3.6.2 to 3.6.3). A bug fix is defined as an internal change that fixes incorrect behavior. +- When releasing new features or non-critical fixes, we make a minor release by changing the y number (ex: 3.6.2 to 3.7.0). +- When releasing breaking changes (backward incompatible), we make a major release by changing the x number (ex: 3.6.2 to 4.0.0). + +See the [semantic versioning](https://dart.dev/tools/pub/versioning#semantic-versions) section from the Dart docs for more information. + +This versioning policy does not apply to prerelease packages (below major version of 1). See this +[StackOverflow thread](https://stackoverflow.com/questions/66201337/how-do-dart-package-versions-work-how-should-i-version-my-flutter-plugins) +for more information on Dart package versioning. + +Whenever possible, we will add deprecation warnings in preparation for future breaking changes. \ No newline at end of file diff --git a/docusaurus/docs/Flutter/01-basics/versioning_policy.mdx b/docusaurus/docs/Flutter/01-basics/versioning_policy.mdx deleted file mode 100644 index 99ec8111d..000000000 --- a/docusaurus/docs/Flutter/01-basics/versioning_policy.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: versioning_policy -sidebar_position: 3 -title: Versioning Policy ---- - -All of the Stream Chat packages follow [semantic versioning](https://semver.org/). - -That means that with a version number x.y.z (major.minor.patch): -- When releasing bug fixes (backwards compatible), we make a patch release by changing the z number (ex: 3.6.2 to 3.6.3). A bug fix is defined as an internal change that fixes incorrect behavior. -- When releasing new features or non-critical fixes, we make a minor release by changing the y number (ex: 3.6.2 to 3.7.0). -- When releasing breaking changes (backward incompatible), we make a major release by changing the x number (ex: 3.6.2 to 4.0.0). - -See the [semantic versioning](https://dart.dev/tools/pub/versioning#semantic-versions) section from the Dart docs for more information. - -This versioning policy does not apply to prerelease packages (below major version of 1). See this -[StackOverflow thread](https://stackoverflow.com/questions/66201337/how-do-dart-package-versions-work-how-should-i-version-my-flutter-plugins) -for more information on Dart package versioning. - -Whenever possible, we will add deprecation warnings in preparation for future breaking changes.