Search Unity

Feedback Minor keyboard event doc improvement

Discussion in 'Immediate Mode GUI (IMGUI)' started by JasonC_, Jun 8, 2021.

  1. JasonC_

    JasonC_

    Joined:
    Oct 27, 2019
    Posts:
    66
    Currently, the first Google result for "unity imgui keyboard input" is https://docs.unity3d.com/ScriptReference/Input.html:

    upload_2021-6-8_12-33-10.png

    It's not very helpful. The relevant documentation is at https://docs.unity3d.com/ScriptReference/Event.KeyboardEvent.html, but does not appear in the results (I checked a few pages in).

    Now, in the Input system docs, the only mention of IMGUI is the very last sentence:

    > This is also unrelated to the IMGUI system.

    There are no links to https://docs.unity3d.com/ScriptReference/Event.KeyboardEvent.html on that page.

    So, given that...
    • "unity imgui keyboard input" seems like a reasonable query when researching IMGUI keyboard input.
    • The Input system page is the first result, and Event.KeyboardEvent does not appear in the result.
    • The Input system page mentions IMGUI (i.e. it seemed to be worth noting that it was unrelated) but fails to link to what you might be looking for.
    I'd like to request the following change to the Input system page:
    • Remove the "This is also unrelated to the IMGUI system" note from the end.
    • Add "Note: This is unrelated to the IMGUI system. For IMGUI keyboard events, see this page" to the very beginning with a link to Event.KeyboardEvent, perhaps in some sort of styled note box.
    I think that this will help direct developers in the right direction after a Google search.

    ---

    In general all of Unity's docs could be generally improved with more cross-references, both between the Manual and the Scripting API, and also within each document. I think this is the type of change that would be a step in a good and helpful direction.