intel / intel/SDM

[Feature]: Always include exceptions instead of telling "Type 2 Class Exception"

Open
#13 1 comment 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
HTML
Stars
29
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Hi,

When browsing for instruction definition you usually want to get all the information in one place.
Today SDM biggest problem from my point of view was introduction of "Type N Class Exception" pages.

When reading about instruction - you get no idea which exceptions it can generate.
When browsing exception classes it is super hard to connect them to relevant instructions.

Ideally everything you show should be on the same page.
It is okay to hide some functions (like AESENC) but it should be easy way to unhide them in same page.
Below instruction definition should be list of all functions collapsed and on click it should expand without opening other page. Same for exceptions generated.

It is huge problem to go seeking what is "Type 2 Class Exception" when you want to know which exceptions can be generated for example by ADDSUBPD. Today it is not even a link.

Contributor guide

Open the contributing guide

Research direction

Start by tracing the instruction-definition and exception-class pages, using ADDSUBPD as the example. Check how functions and generated exceptions are presented, then verify that both can be expanded on the instruction page without opening another page and that exception types connect to their details.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.