-
Notifications
You must be signed in to change notification settings - Fork 190
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
The VM is well-documented in several aspects but the documentation is often hard to find and not cross-referenced, and in some cases outdated. To consolidate docs we should:
- Clean up, review and reorganize documents in the docs folder.
- Create a docs.rs module whose module docs include the README, and documents in the docs folder, similar to the one in native.
- Install aquamarine dependency to include mermaid diagrams in rust doc.
- Make README link to the deployed benchmark results.
- Modify the github pages deployment job to include deployment of both rustdoc and benchmark pages.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation