diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..e25801f1 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,81 @@ +# Changelog +All notable changes to the Cartesi documentation will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +- New wallet tutorials for Ether, ERC20, ERC721 +- Migration guide for Node 1.5.0 +- A React.js frontend tutorial +- CLI commands page +- Community tools page + + +### Changed +- Revised core concepts explanations to reflect epoch length +- Improved the troubleshooting guide with more common scenarios +- Enhanced security considerations section for dApp development +- Rollups contract link references +- Architecture section with Cartesi machine section, more images and improved structure +- Edit page tab -> Report an error(create an issue) + +### Removed +- Removed community tools from quickstart guide +- Cartesi Machine page +- Node configuration guide +- Removed machine learning tutorial +- Removed `cartesi-wallet` tutorials + + + +## [1.3.0](https://github.com/cartesi/docs/releases/tag/v1.3.0) - 2024-04-09 +### Added +- Quickstart guide for building Cartesi dApps +- FAQ section addressing common issues and questions +- Optimistic Rollups section in the Core Concepts +- Architecture section in the Core Concepts +- Added troubleshooting guide for common issues in Cartesi dApps +- A development section with installation and build instructions for Cartesi Rollups +- Migration guide from Cartesi CLI to Sunodo CLI +- Machine learning tutorials +- Wallet tutorials +- Self hosted deployment guide +- Node configuration guide + +### Changed +- Cartesi Rollups section became Core Concepts section +- Rollups HTTP APIs section was renamed to Rollups APIs +- Expanded the troubleshooting guide with more common scenarios +- Send requests and Retrieve Outputs page +- Monotonous Docker commands were replaced with Sunodo CLI +- Sunodo CLI changed to Cartesi CLI +- Mainnet risk to mainnet considerations +- Update Calculate tutorial to use Cartesi CLI + +### Removed +- Fortune dApp tutorial +- Host mode instructions +- Perfomance recommendations section +- Run an example dApp section +- Current challenges section +- dApp life cycle and dApp architecture sections +- Main concepts sections + + +## [1.0.0](https://docs.cartesi.io/cartesi-rollups/1.0/overview/) - 2023-08-24 +### Added +- Installation guide for Cartesi development environment +- Basic "Hello World" dApp tutorial +- Basic fortune dApp tutorials +- Overview of Cartesi's architecture and key concepts +- Guide on building and deploying simple Cartesi dApps + + +### Changed +- Migrated content from old wiki to new documentation format +- Standardized terminology across all documentation + +