Skip to content

[docs] Move Bytecode documentation#387

Draft
gregnazario wants to merge 9 commits intomainfrom
bytecode-docs
Draft

[docs] Move Bytecode documentation#387
gregnazario wants to merge 9 commits intomainfrom
bytecode-docs

Conversation

@gregnazario
Copy link
Collaborator

An attempt at documenting the bytecode, with claude's help over the codebase.

Added collapsible "Bytecode Reference" group under Smart Contracts >
Tooling with entries for overview, module format, instruction set,
type system, and version history pages. Nav labels added in English,
Spanish, and Chinese.
Previously the hook ran remark on ALL MDX files in src/content/
regardless of which files were staged, causing output path conflicts.
Now nano-staged passes only staged file paths to remark.

Also adds bytecode overview and version history pages.
Module format page documents the complete binary specification:
header layout, table directory, ULEB128 encoding, all 18 table
types with field-level serialization details.

Type system page covers signature tokens, abilities, the handle
indirection model, generics, function types, and visibility.
Complete reference for all 111 Move bytecode instructions organized
by category, with opcodes, operands, stack effects, and semantics.
Expanded Move Bytecode definition and added Opcode entry across
English, Spanish, and Chinese glossaries with links to the new
bytecode reference documentation.
The previous commits had content in the wrong files: index.mdx had
version history content (duplicating version-history.mdx), module-format.mdx
had type system content (duplicating type-system.mdx), and instructions.mdx
was empty. This commit replaces all three with their correct content.
…nces

The previous commit left index.mdx and module-format.mdx empty. This
commit adds the correct content: a bytecode reference overview and a
complete module binary format specification (header, table directory,
all 19 table types, code unit format). Also fixes the constant-pool
anchor link in instructions.mdx and applies remark formatting to
type-system.mdx.
Translates all 5 bytecode documentation pages to both Spanish and
Chinese: overview (index), module binary format, instruction set
reference, type system, and version history. All internal links
use the correct language prefixes (/es/ and /zh/).
Applies remark table alignment formatting to the Spanish module
binary format page.
@vercel
Copy link

vercel bot commented Mar 2, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
aptos-docs Ready Ready Preview, Comment Mar 2, 2026 6:16pm

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant