affine/Mycelium
2
1
Fork 0
Code Issues 30 Pull requests Projects 4 Releases Packages Wiki Activity Actions

better instruction documentation #37

New issue
Closed
opened 2025-07-25 20:18:05 -07:00 by affine · 1 comment
affine commented 2025-07-25 20:18:05 -07:00
Owner
Copy link

instruction descriptions should clearly outline side effects of instruction logic including destructive vs non destructive operations and deep copy vs shallow copies.

We should also support documentation on the addressing modes and facilities available to the VM within the instr.toml (maybe rename to vm.toml).

perhaps a user manual should be autogenerated from the instr.toml (as a CI job perhaps)

instruction descriptions should clearly outline side effects of instruction logic including destructive vs non destructive operations and deep copy vs shallow copies. We should also support documentation on the addressing modes and facilities available to the VM within the instr.toml (maybe rename to vm.toml). perhaps a user manual should be autogenerated from the instr.toml (as a CI job perhaps)
affine added this to the HyphaeVM Roadmap project 2025-07-25 20:18:06 -07:00
affine self-assigned this 2025-07-25 23:35:54 -07:00
affine commented 2025-08-08 22:34:26 -07:00
Author
Owner
Copy link

If possible a software manual for HyphaeVM should be written in latex that can parse and include the items in instructions.toml automatically.

A CI job should test that it can build.

If possible a software manual for HyphaeVM should be written in latex that can parse and include the items in instructions.toml automatically. A CI job should test that it can build.
affine referenced this issue from a commit 2025-08-19 13:33:54 -07:00
Generate a user manual.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
usage-instructions
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
HyphaeVM Roadmap
Assignees
Clear assignees
No assignees
affine
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: affine/Mycelium#37
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?