Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: first go at generated AVM instruction set doc #3469

Merged
merged 11 commits into from
Nov 30, 2023
Merged

docs: first go at generated AVM instruction set doc #3469

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
91821d0
first go at generated AVM instruction set doc
dbanks12 Nov 29, 2023
def5dba
instruction name fix
dbanks12 Nov 29, 2023
ea42699
instruction set typo
dbanks12 Nov 29, 2023
2cf8b31
rerun preprocess after typo fixes
dbanks12 Nov 29, 2023
2b2a360
tag subop rename
dbanks12 Nov 29, 2023
70a9900
yarn start preprocesses
dbanks12 Nov 29, 2023
0e25b9b
added op-type/dest-type flags, historical roots/accesses, opcodes
dbanks12 Nov 29, 2023
cccb5ea
set doesn't support field
dbanks12 Nov 29, 2023
cc69471
update cast description
dbanks12 Nov 29, 2023
18f4634
bit-sizes in instruction set
dbanks12 Nov 29, 2023
63d6d0c
Instruction images
dbanks12 Nov 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions yellow-paper/docs/public-vm/InstructionSet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Instruction Set

import GeneratedInstructionSet from './gen/_InstructionSet.mdx';

<GeneratedInstructionSet />
Empty file added yellow-paper/docs/public-vm/Types.mdx
View file
Open in desktop
Empty file.
8 changes: 8 additions & 0 deletions yellow-paper/docs/public-vm/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "AVM: Aztec's Public VM",
"position": 5,
"link": {
"type": "generated-index",
"description": "Aztec's Public VM..."
}
}
1,240 changes: 1,240 additions & 0 deletions yellow-paper/docs/public-vm/gen/_InstructionSet.mdx
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions yellow-paper/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"start:dev": "docusaurus start --host 0.0.0.0",
"start": "yarn preprocess && docusaurus start",
"start:dev": "yarn preprocess && docusaurus start --host 0.0.0.0",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"preprocess": "yarn node ./src/preprocess/InstructionSetMarkdownGen.tsx",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
"typecheck": "tsc"
Expand All @@ -23,6 +24,7 @@
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-markdown": "6.0.0",
"rehype-katex": "5",
"remark-math": "3"
},
Expand Down
Loading