-
Notifications
You must be signed in to change notification settings - Fork 216
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.
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
Update RISC-V ISA documentation #492
Conversation
@dramforever requesting your thoughts. |
LGTM. I think for version string maybe QEMU as you said and also GCC and Binutils version? |
Now that I think about it, none of the QEMU, GCC, or any runner tool version is specific to riscv language, so I wouldn't think it appropriate for the riscv specific docs. |
My understanding is that GCC, Binutils, QEMU are in fact unique to |
Huh. I see. If you know where to look, could you get me any relevant version info to include? I'm not familiar at all with the runner or toolchain. |
Just had an idea to "cheat" and do a
As for QEMU I think this means we're using 7.1 codewars/riscv#9 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very detailed, LGTM!
Looking at the preview here: https://deploy-preview-492--reverent-edison-2864ea.netlify.app/languages/riscv I am not sure I like the style of the asterisk/dagger/etc. annotations. Formatting is a bit off, and I htink they might look somewhat unusual to people more familiar with just numbered annotations like 1) . What do you think? |
The style seems in line with official RISC-V documentation, but I agree their appearance isn't that common in the Codewars docs and might not fit in well with the rest of the documentation. I'm personally not bothered by it but let's collect some opinions from a few others before we decide whether to stick to the current style or revert to plain numbered annotations. |
Is there precedent elsewhere in the docs? I searched through the repo and found one other instance of the single dagger (in content\gamification\priveleges.md:27,32) and none of the double dagger or section symbol. I tried looking for instances of |
Numbers vs daggers is one thing, and we can fix it later if needed. But another thing which puts me off a bit is that the footnote markers seem to be not superscripted, neither in the main text, nor in footnotes themselves? |
I see what you mean. I like the look of superscripts as well. Adding. |
I suspect netlify's md engine doesn't like the `sup` tag right next to the md link syntax.
Simple edit to reflect the extra extensions supported in codewars/riscv#7. Also adds links to specifications since some extensions are not included in the RISC-V Spec.
Still not completely happy with line 13, I feel like it's not visually appealing but the ISA string the closest there is to a version number. Maybe listing the QEMU version? Not sure.
As I will comment in codewars/riscv#7 as well, Zbkx is not necessary as it's in both Zk and Zks shorthands.