Skip to content
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

Documentation Enhancements #192

Open
evadne opened this issue May 14, 2023 · 0 comments
Open

Documentation Enhancements #192

evadne opened this issue May 14, 2023 · 0 comments

Comments

@evadne
Copy link

evadne commented May 14, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant