docs: split opcode JIT status by backend by siyul-park · Pull Request #117 · siyul-park/minivm

siyul-park · 2026-07-05T13:38:13Z

Summary

Split the instruction-set JIT status into per-opcode rows with separate ARM64 and AMD64 columns.
Document the AMD64 backend state explicitly as unavailable while asm/amd64 remains a placeholder and non-ARM64 uses the JIT stub.
Add README cross-links from summary sections to the owning detailed docs in English, Korean, and the docs index.

Notes

This is documentation-only.
The opcode table is kept in instr/opcode.go order so future opcode additions can be checked directly against the source of truth.

Summary by CodeRabbit

Documentation
- Expanded README cross-links to help readers find architecture, host integration, memory model, JIT internals, and roadmap details more easily.
- Clarified usage and performance guidance with more direct references for building, optimization, debugging, and profiling.
- Improved the instruction set documentation with a clearer opcode reference, backend/JIT availability status, and compatibility notes.
- Updated the docs guide to better explain ownership and where detailed information lives.

coderabbitai · 2026-07-05T13:38:31Z

📝 Walkthrough

Walkthrough

This PR expands cross-referencing between README.md, README.ko.md, and docs/ across most feature sections, and restructures documentation ownership guidance in docs/README.md. docs/instruction-set.md is significantly reworked, converting opcode documentation into a per-opcode Opcode Reference table with separate ARM64/AMD64 JIT status columns.

Changes

Documentation updates

Layer / File(s)	Summary
README.md cross-link expansion `README.md`	Adds a documentation map and links to architecture, host-integration, memory-model, jit-internals, pass-system, profile, instruction-set, verification, compatibility, and roadmap docs across intro, usage, optimizer, JIT, options, and status sections.
README.ko.md mirrored cross-link expansion `README.ko.md`	Applies the equivalent documentation-map and section link expansions to the Korean README, mirroring the English version's changes.
Docs ownership and cross-reference table `docs/README.md`	Adds a README Cross-Reference section with a table mapping README sections to owning documents, and updates Document Ownership/Reading Guide to include per-backend JIT status for instruction-set.md.
Opcode reference and JIT status restructuring `docs/instruction-set.md`	Rewrites Source of Truth references, replaces the JIT Status section with a per-opcode/per-backend status legend (including an AMD64 unavailable note), converts the Opcode Families summary into a detailed per-opcode Opcode Reference table with ARM64/AMD64 status columns, and updates Maintenance Notes and Related Docs.

Estimated code review effort: 2 (Simple) | ~15 minutes

Related PRs: None identified.

Suggested labels: documentation

Suggested reviewers: siyul-park

🐰 A rabbit hops through docs anew,
Linking paths both old and true,
Opcodes sorted, ARM and AMD,
READMEs now with docs befriend,
Two languages, one map to view.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly matches the main change: splitting opcode JIT status by backend.
Description check	✅ Passed	The description covers the key changes and notes, and only omits some template sections like Related Issues and Additional Information.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/opcode-jit-matrix-links

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

🧹 Nitpick comments (1)

docs/instruction-set.md (1)
18-19: 📐 Maintainability & Code Quality | 🔵 Trivial

Include the AMD64 placeholder backend in the ownership map.

interp/jit_stub.go covers the stub path, but the AMD64 placeholder contract is also part of this change set (asm/amd64 in the compatibility docs). Add that file here so the ownership map stays complete.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/instruction-set.md` around lines 18 - 19, The ownership map in the
instruction set is missing the AMD64 placeholder backend entry, so update the
table in docs/instruction-set.md to include the asm/amd64 contract alongside
interp/jit_stub.go and docs/compatibility.md. Keep the mapping complete by
adding the AMD64 placeholder backend under the relevant ownership/category row,
using the existing table structure and symbols as the reference points.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/instruction-set.md`:
- Around line 18-19: The ownership map in the instruction set is missing the
AMD64 placeholder backend entry, so update the table in docs/instruction-set.md
to include the asm/amd64 contract alongside interp/jit_stub.go and
docs/compatibility.md. Keep the mapping complete by adding the AMD64 placeholder
backend under the relevant ownership/category row, using the existing table
structure and symbols as the reference points.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: aa3967e8-a7ff-422b-8fd3-6394a84403a3

📥 Commits

Reviewing files that changed from the base of the PR and between d04e8ef and c8158d6.

📒 Files selected for processing (4)

README.ko.md
README.md
docs/README.md
docs/instruction-set.md

siyul-park added 4 commits July 5, 2026 22:35

docs: link README sections to detailed docs

52fc8eb

docs: link README sections to detailed docs

512e638

docs: link Korean README sections to detailed docs

439771f

docs: split opcode JIT status by backend

c8158d6

siyul-park merged commit 7ab43fd into main Jul 5, 2026
5 of 6 checks passed

siyul-park deleted the docs/opcode-jit-matrix-links branch July 5, 2026 13:40

coderabbitai Bot reviewed Jul 5, 2026

View reviewed changes

coderabbitai Bot mentioned this pull request Jul 5, 2026

docs: simplify README links #118

Merged

coderabbitai Bot mentioned this pull request Jul 17, 2026

perf(interp): expand JIT coverage for container ops and equality #158

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: split opcode JIT status by backend - #117

docs: split opcode JIT status by backend#117
siyul-park merged 4 commits into
mainfrom
docs/opcode-jit-matrix-links

siyul-park commented Jul 5, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 5, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

siyul-park commented Jul 5, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Notes

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

siyul-park commented Jul 5, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 5, 2026 •

edited

Loading