Skip to content

Commit

Permalink
docs: add migration from 4.x.x to 5.x.x documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thepiwo committed Nov 19, 2024
1 parent d95ddc3 commit bdf4507
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 7 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@ npm install -g @aeternity/aeproject

## Documentation

- [Quick Start](docs/index.md)
- [Project Initialization](docs/cli/init.md)
- [Local Environment](docs/cli/env.md)
- [Unit Testing](docs/cli/test.md)
- [AEproject Library](docs/lib.md)
- [Migration from 3.x.x to 4.x.x](docs/migration-from-3.x.x-to-4.x.x.md)
* [Quick Start](docs/index.md)
* [Project Initialization](docs/cli/init.md)
* [Local Environment](docs/cli/env.md)
* [Unit Testing](docs/cli/test.md)
* [AEproject Library](docs/lib.md)
* [Migration from 3.x.x to 4.x.x](docs/migration-from-3.x.x-to-4.x.x.md)
* [Migration from 4.x.x to 5.x.x](docs/migration-from-4.x.x-to-5.x.x.md)
- [Upcoming Version Support](docs/next-support.md)

## Release Process
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Creates a new project structure with a few folders in which the developer can cr

## Update existing project

For upgrade from old AEproject versions check out [Migration from 3.x.x to 4.x.x](../migration-from-3.x.x-to-4.x.x.md).
For upgrade from old AEproject versions check out [Migration from 3.x.x to 4.x.x](../migration-from-3.x.x-to-4.x.x.md) and [Migration from 4.x.x to 5.x.x](../migration-from-4.x.x-to-5.x.x.md).

```text
aeproject init --update
Expand Down
14 changes: 14 additions & 0 deletions docs/migration-from-4.x.x-to-5.x.x.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Migration from 4.x.x to 5.x.x

## Changes
**AEproject** `v5.0.0` underwent some minor but breaking changes.

Install the new AEproject version
```
npm install -g @aeternity/aeproject
```

### Removed from libs
Following utils have been removed and cannot be used anymore:

- `utils.getFilesystem()` discontinued, as it is now natively available in the sdk via import, e.g. `const { getFileSystem } = require("@aeternity/aepp-sdk");`
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,5 @@ nav:
- cli/test.md
- lib.md
- migration-from-3.x.x-to-4.x.x.md
- migration-from-4.x.x-to-5.x.x.md
- next-support.md

0 comments on commit bdf4507

Please sign in to comment.