Skip to content

Commit

Permalink
feat(doc): merge version policy and choose package pages into an Inst…
Browse files Browse the repository at this point in the history
…allation page
  • Loading branch information
esarbanis authored and kanat committed Jan 4, 2024
1 parent 545db7e commit 3971d34
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 21 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: choose_package
id: installation
sidebar_position: 2
title: Installation
---
Expand Down Expand Up @@ -55,3 +55,20 @@ and architecture.
<b>Summary:</b>

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.
20 changes: 0 additions & 20 deletions docusaurus/docs/Flutter/01-basics/versioning_policy.mdx

This file was deleted.

0 comments on commit 3971d34

Please sign in to comment.