add documents #1307
add documents #1307
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request adds a comprehensive set of documentation for both the Neo Smart Contract Framework and the Neo C# Compiler, aimed at guiding developers through smart contract development, setup, and deployment. The new content details core concepts of NeoVM & GAS, getting started guides, and in-depth compiler documentation covering installation, options, internals, debugging, security analysis, and more.
- Introduces detailed documentation pages for framework topics including NeoVM, GAS, and smart contract basics.
- Provides comprehensive guides for setting up development environments, installing tools, and creating the first smart contract.
- Expands the compiler documentation with internal architecture, usage instructions, available options, and maintenance guidelines.
Reviewed Changes
Copilot reviewed 67 out of 67 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/framework/03-core-concepts/01-neovm-gas.md | Adds an introductory document covering NeoVM and GAS concepts. |
| docs/framework/02-getting-started/README.md | Provides a getting started guide for Neo smart contract development. |
| docs/framework/02-getting-started/03-first-contract.md | Introduces a step-by-step guide for creating a "Hello World" Neo contract. |
| docs/framework/02-getting-started/02-installation.md | Outlines framework and compiler installation and setup instructions. |
| docs/framework/02-getting-started/01-setup.md | Describes the environment setup required for Neo smart contract development. |
| docs/framework/01-introduction/*.md | Introduces Neo, smart contracts, and reasons to use C# on Neo. |
| docs/compiler/*.md | Provides new documentation for the Neo C# Compiler including its usage, options, internals, and maintenance guides. |
| docs/compiler/01-using-compiler.md | Explains how to use the compiler with practical examples and integration scenarios. |
|
Great job! |
| * **File:** `<BaseName>.nef.txt` (e.g., `MyContract.nef.txt`) | ||
| * **Content:** Detailed breakdown of the NEF file structure, including script hash, opcodes with offsets, and potentially integrated debug information. Generated with the `--assembly` option. | ||
|
|
||
| * **Artifacts (`.cs`, `.dll`):** |
There was a problem hiding this comment.
Very good!
I think that some examples of a simple contract here with explanation would be something very good to add to this guideline
There was a problem hiding this comment.
I mean results of asm, results of optimized nef, artifacts, etc. Just for a simple contract
| * **Default:** Inlining is generally enabled. | ||
| * **Example:** `nccs MyContract.csproj --no-inline` | ||
|
|
||
| * **`--address-version <VERSION>`** |
There was a problem hiding this comment.
Very good job, @Jim8y
I was not even aware of this address-version.
When was this included? I do not remember.
|
|
||
| ## Core Principles | ||
|
|
||
| * **Automation:** Code executes automatically when predefined conditions are met, removing the need for intermediaries. |
| // destroy method (optional, to allow contract self-destruction) | ||
| // public static void destroy() { ... } | ||
| } | ||
| } |
There was a problem hiding this comment.
Good example, based on this example we could add the nef,artifacts, optimized nef, etc
this pr adds document system for compiler and framework.