geo icon indicating copy to clipboard operation
geo copied to clipboard

Add visuals to the documentation

Open frewsxcv opened this issue 4 years ago • 6 comments

Adding visuals to the documentation could be helpful for people like me who have trouble focusing on big blocks of text. Some examples I'm thinking:

  • Add a basic visual for each geometry type we offer (Shapely does this)
  • When appropriate, add a visual for each algorithm. For example, it's come up a couple times how Extremes and BoundingRect differ (happened to me once too), and I think a visual would really help here

As for the how, here's the code for how Shapely generates their visuals: https://github.com/Toblerity/Shapely/tree/master/docs/code

I was thinking we can create a new repo in the GeoRust org called 'diagrams' (or 'visuals' or reuse the existing 'static' repo) that would include both the code to generate the visuals, and also host them via GitHub pages.

frewsxcv avatar Jan 11 '21 17:01 frewsxcv

+100000 to this

urschrei avatar Jan 11 '21 17:01 urschrei

As for the how, here's the code for how Shapely generates their visuals: https://github.com/Toblerity/Shapely/tree/master/docs/code

As you mention Shapely, do you have in mind a particular programming language to add this functionality or could Rust also be considered? I found the kiss3d quite easy to use and with enough functionality to support line / polygon drawing on a simple birds-eye view.

Nevsden avatar Feb 05 '21 08:02 Nevsden

As for the how, here's the code for how Shapely generates their visuals: https://github.com/Toblerity/Shapely/tree/master/docs/code

As you mention Shapely, do you have in mind a particular programming language to add this functionality or could Rust also be considered? I found the kiss3d quite easy to use and with enough functionality to support line / polygon drawing on a simple birds-eye view.

My thinking is Rust would be preferred for this. But if that's a pain or the tooling isn't mature enough, then another language like Python is acceptable

frewsxcv avatar Feb 06 '21 15:02 frewsxcv

https://github.com/rust-lang/rust/issues/32104#issuecomment-1040924373

frewsxcv avatar Nov 08 '23 02:11 frewsxcv