Skip to content

Commit 8e513df

Browse files
docs: add version compatibility guide (#1075)
1 parent db76b60 commit 8e513df

File tree

3 files changed

+25
-31
lines changed

3 files changed

+25
-31
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Version Compatiblity
2+
3+
Analog is compatible across multiple versions of Angular, Nx, and Vite.
4+
5+
Its always recommended to use the latest version of Analog because there are bug fixes and features continually being added.
6+
7+
Below is a reference table that matches versions of Nx and Angular with the Analog version that is compatible with it.
8+
9+
The table shows the minimum version of Nx, the supported Angular version, and the minimum supported version of Analog and Vite.
10+
11+
| Nx Version _(min)_ | Angular Version | Analog Version | Vite Version |
12+
| ------------------ | --------------- | -------------- | ------------ |
13+
| 18.0.0 | ^17.0.0 | **latest** | ^5.0.0 |
14+
| 17.0.0 | ^17.0.0 | **latest** | ^5.0.0 |
15+
| 16.1.0 | ^16.1.0 | **~1.1.0** | ^5.0.0 |
16+
| 16.0.0 | ~15.2.X | **~1.1.0** | ^5.0.0 |
17+
| 15.2.0 | ~15.2.X | **~1.1.0** | ^5.0.0 |
18+
19+
Additionally, you can check this [guide from Nx](https://nx.dev/packages/angular/documents/angular-nx-version-matrix)
20+
to learn more about Nx and Angular compatibility.

apps/docs-app/sidebars.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,11 @@ const sidebars = {
160160
id: 'guides/migrating',
161161
label: 'Migrating an Angular app to Analog',
162162
},
163+
{
164+
type: 'doc',
165+
id: 'guides/compatibility',
166+
label: 'Version Compatibilty',
167+
},
163168
],
164169
},
165170
{

packages/nx-plugin/src/generators/app/versions/README.md

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

0 commit comments

Comments
 (0)