Fixed misspelling of "RGB" in English in a few spots in the docs. #1963
Conversation
fmresearchnovak
requested review from
BFH-ktt1,
davidhutchens,
maehne,
MarcinOrlowski and
zdimension
as code owners
| @@ -173,15 +173,15 @@ | |||
| <tocitem target="io_joystick" text="Joystick" image="icon_joystick" /> | |||
| <tocitem target="io_keyboard" text="Keyboard" image="icon_keyboard" /> | |||
| <tocitem target="io_led" text="LED" image="icon_led" /> | |||
| <tocitem target="io_ledRVB" text="LED RVB" image="icon_rvbled" /> | |||
| <tocitem target="io_ledRVB" text="LED RGB" image="icon_rvbled" /> | |||
There was a problem hiding this comment.
Could you please also fix the typo in the image attribute? This might also require renaming icon_rvbled in other places.
| <tocitem target="io_7seg" text="7-Segment Display" image="icon_7seg" /> | ||
| <tocitem target="io_hexdig" text="Hex Digit Display" image="icon_hexdig" /> | ||
| <tocitem target="io_dotmat" text="LED Matrix" image="icon_dotmat" /> | ||
| <tocitem target="io_tty" text="TTY" image="icon_tty" /> | ||
| <!-- not documented | ||
| <tocitem target="io_Port_IO" text="Port I/O" image="icon_Port_IO" /> | ||
| <tocitem target="io_Repetar" text="Reptar Local Bus" image="icon_repetar" /> | ||
| <tocitem target="io_videorvb" text="Video RVB" image="icon_videorvb" /> | ||
| <tocitem target="io_videorvb" text="Video RGB" image="icon_videorvb" /> |
There was a problem hiding this comment.
Could you please also fix the typo in the image attribute? This might also require renaming icon_rvbled in other places.
In French "RGB colour" translates to "couleur RVB" (rouge, verte, bleu), which is the origin for this typo, as many contributions to the documentation came from native French speakers. In German it's for sure "RGB". For the other languages, you could check, e.g., with DeepL the translation. Some translations might have kept the English component name. |
Contributions to the documentation are always welcome! @mbaillif has contributed most to it over the years and may help you in case of questions. @BFH-ktt1 developed the SOC components. Since the current HTML-based help system is very tedious to maintain, we would like to migrate the existing documentation to some solution, which uses a more friendly markup and which can be read in a more comfortable way inside the web browser. It shall be still locally available. Unfortunately, our ressources are limited and we have not yet found the time to investigate it further. |
|
I'm working on fixing the "RVB" typo throughout the code (except for French translation) based on the comments in this thread. Thank you for the guidance. I used grep to find all the spots where "rvb" appears and started working through them so I can be sure I get all instances of the typo and all references to the icon (icon_rvbled). See here: rvb_grep.txt I'm feeling a bit overwhelmed since I don't know the code base very well. Where or what is pt/html/libs/io/videorvb.html ? It, and some similar files, are referenced, but the files themselves don't appear to be in this repo. Am I missing something? |
|
I have done my best to address all the typos of "RVB" for "RGB" in all languages. See the latest commit on this pull request. Please let me know what can be done to git this pull request approved and merged in. Thank you! :D |
Hello,
I (https://ednovak.net/) am a Computer Science professor at a small private college in the United States. I am teaching a course using this awesome software. I noticed some misspellings in the English documentation and thought it might be helpful if I fixed them. I wasn't as confident about the other translations (Russian, French, etc.), but it does seem to me that the same typo appears in those languages as well.
I am considering writing some documentation about the SOC components (especially the RISC-V simulator and VGA screen) since it seems like the project needs it. Would that be welcome?
Thank you!