revisit docstrings and optionally add demo page for public interfaces

[johnnychen94]

Before 1.0 release, we'll need to revisit our public interfaces, if necessary, update the docstrings and add potential demos to https://juliaimages.org/stable/examples/. My personal experience is that JuliaImages already have a lot of nice functions, but without proper education, people would not know their existence and would just miss their MATLAB/python correspondings.

This issue is used to track the progress when someone (maybe me) starts the work.

[Jay-sanjay]

Sir, I would be more than happy to contribute to this docs In this I only need to explain the commands and functioning of each function , am I right ??

[ashwani-rathee]

Hey Jay 👋🏻,glad to have you here! Yes that's the purpose of this issue. https://github.com/JuliaImages/juliaimages.github.io is where the documentation is and https://github.com/JuliaImages/juliaimages.github.io/blob/source/docs/src/api_comparison.md this is where we compare different packages. Also couple of demonstrations PRs that need to be finished there: https://github.com/JuliaImages/juliaimages.github.io/pulls.

[Jay-sanjay]

[Jay-sanjay]

sir can you tell exactly where do I need to make changes in the docs part

[Jay-sanjay]

Sir can you please help me in this I am a bit new to open-source contribution

[ashwani-rathee]

I think this being updated would be quite helpful :https://github.com/JuliaImages/juliaimages.github.io/blob/source/docs/src/api_comparison.md