[#2094] Translate `Ast_typed` into TypeScript for docs generation
Motivation and Context
This MR adds ligo doc
command which will generate docs for the project. Only JsLIGO is supported at this moment.
Problem
We want to generate docs in LIGO. We decided to translate
JsLIGO contracts into TypeScript and run typedoc
on it after.
Solution
Translate the Ast_typed
representation into TypeScript.
The translation is described here
Example of docs
@ligo/fa
Example pages ofComponent
-
compiler -
website -
webide -
vscode-plugin -
debugger
Types of changes
-
Bug fix (non-breaking change which fixes an issue) -
New feature (non-breaking change which adds functionality) -
Breaking change (fix or feature that would cause existing functionality to not work as expected) -
Performance improvement (non-breaking change that improves performance) -
None (change with no changelog)
Changelog
Added a ligo doc
command which will generate documentation for your project. At this moment only JsLIGO is supported and it requires typedoc
to be installed.
Related MR
Checklist:
-
If a new syntax has been introduced, put a message on slack ligo-lsp -
Changes follow the existing coding style (use dune @fmt
to check). -
Tests for the changes have been added (for bug fixes / feature). -
Documentation has been updated. -
Changelog description has been added (if appropriate). -
Start titles under ## Changelog
section with #### (if appropriate). -
There is no image or uploaded file in changelog -
Examples in changed behaviour have been added to the changelog (for breaking change / feature).
Edited by Leonid Vasilev