cocoa-xu / evision

Evision: An OpenCV-Erlang/Elixir binding
https://evision.app
Apache License 2.0
337 stars 22 forks source link

Documentation Enhancements #192

Open evadne opened 1 year ago

evadne commented 1 year ago

Some minor suggestions:

  1. Group modules into categories using module groups e.g. official OpenCV documentation has groups under Core Functionalities such as Operations on Arrays etc.

  2. Group functions in base module (Evision) based on existing OpenCV group organisation using @doc group: "…" since there are a lot of functions at the root level (if they are not being moved to their own modules). e.g. https://hexdocs.pm/ecto/Ecto.Repo.html#c:checked_out?/0 is under a group. Assumption is that any user would have known how to use OpenCV anyway and so they would have had a mental model based on existing OpenCV organisation of functions & documentation.

  3. Optimise MathJax usage so the page scrolls at 60 FPS on Safari

  4. Fix the “Pages” under https://hexdocs.pm/evision/Evision.html so the examples are grouped together etc.

I can help with any of the 4 but the item on MathJax may be very difficult. Regarding MathJax a separate approach would be to explore server-side pre-rendition, would be more involved & maybe needs support from ExDoc, but the page will be 100 times faster.