This repository contains Design Notes describing developer tools for the NEO project.
Design Notes is a process for making and disseminating architecturally important design decisions. NGD Seattle is using this process to drive decisions across several projects related to the NEO developer experience, including NEO Express and the NEO Smart Contract Debugger for Visual Studio Code.
The Design Note process was pioneered by Galen Hunt on several projects at Microsoft and was released publicly as part of Microsoft's xlang project.
The Design Note process is described in DN00. This document is project independent by design. The remaining documents in this repository are specific to the NEO developer experience and are prefixed with "NDX".
This repository contains the following foundational design notes:
- NDX-DN01 describes the goals and guiding principles of a world-class experience for developers targeting the NEO platform.
- NDX-DN02 describes NEO's unified programming model.
- NDX-DN03 describes NEO Express, a NEO blockchain client application, optimized for development scenarios.
- NDX-DN04 describes the NEO Smart Contract Debugger for Visual Studio Code.
- NDX-DN05 describes the libraries and tools used by .NET developers to target the NEO platform.
This repository also contains the following design notes that describe enhancements to the NEO developer experience foundation.
- NDX-DN11 describes an improvement to enable NEO Express to be integrated into tools and IDEs such as VSCode
- NDX-DN12 describes the format of debug information that will be generated by NEO smart contract compilers and will be consumed by the NEO Smart Contract debugger.
Additional Design Notes will be added in the future.