Mirror of forum.nim-lang.org

10927 :: Feedback on site: Scroll to Top or Update Design for Docs

• mig (orginal) [2024-01-29T19:28:05+01:00] view original

  Imagine the following scenario:

  1. Searching the documentation for a specific function, e.g. all
  2. Click all, read it
  3. Search for another function, e.g. map
  4. At this point the user must scroll to the top of the page manually to see their results

  I propose (1) a simple "scroll to top" button aligned on the right side of the page or (2) automatic scrolling behavior to the top when typing in the search box.

  There may be other ways to accomplish this, via a different design choice, but it seems like this is the best option.

---

• xigoi (orginal) [2024-01-29T23:18:15+01:00] view original

  Does your keyboard not have a button for scrolling to top (Home)?

---

• pierce-jason (orginal) [2024-01-30T04:36:00+01:00] view original

  Mine do not have a HOME button. I use Win10 onscreen keyboard, or a compact function-mixed Bluetooth board. The Bluetooth one technically has a HOME key, but it takes multiple (single handed) keystrokes. In most programs I normally use "ctrl-a" or "ctrl-a arrow". Similarly, my keyboards are pgUp/down deficient.

---

• georgelemon (orginal) [2024-01-30T06:27:38+01:00] view original

  In my case I'm using a magic keyboard without keypad, so no.

  Actually, instead of adding extra things I would prefer a hook-like argument for injecting additional CSS/JS scripts. Not sure if this is already possible.

   nim doc lovely.nim --assets:"./some/jsfile.js"
  Run

---

• amadan (orginal) [2024-01-30T06:37:48+01:00] view original

  In devel the results are positioned so they are always visible (e.g. search for something here https://nim-lang.github.io/Nim/re.html#%3D~.t%2Cstring%2CRegex) Although imo the current floating design doesn't look good.

  @georgelemon you can create a nimdoc.cfg file and override the doc.file setting

---

• mig (orginal) [2024-01-30T08:12:19+01:00] view original

  No, I use a Macbook Pro keyboard. The design should assume a particular keyboard layout in any case.

---

• mig (orginal) [2024-01-30T08:12:51+01:00] view original

  even if fn + up does the same thing

  Didn't know this trick. Thanks for this.

---

• mig (orginal) [2024-01-30T08:13:54+01:00] view original

  In devel the results are positioned so they are always visible (e.g. search for something here https://nim-lang.github.io/Nim/re.html#%3D~.t%2Cstring%2CRegex)

  Thanks didn't realize this was the case. Will use the devel docs from now, since I'm using a devel nim compiler.

---