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

Add visuals to the documentation #601

Open
frewsxcv opened this issue Jan 11, 2021 · 6 comments
Open

Add visuals to the documentation #601

frewsxcv opened this issue Jan 11, 2021 · 6 comments
Labels

Comments

@frewsxcv
Copy link
Member

frewsxcv commented Jan 11, 2021

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 frewsxcv added the idea label Jan 11, 2021
@urschrei
Copy link
Member

+100000 to this

@Nevsden
Copy link

Nevsden commented Feb 5, 2021

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.

@frewsxcv
Copy link
Member Author

frewsxcv commented Feb 6, 2021

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
Copy link
Member Author

frewsxcv commented Nov 8, 2023

@dabreegster
Copy link
Contributor

I'm messing around in https://github.com/dabreegster/georust-tester with an idea for a small web app that lets you fiddle with geometry in MapLibre, then interactively call georust APIs through WASM. If the initial idea proves useful, I'd be happy to figure out how to embed these in the docs or link to them.

@frewsxcv
Copy link
Member Author

@dabreegster I finally took a look and this is really promising! I think it's worth moving forward with experimenting with adding an <iframe> to your examples in the documentation, and then we can evaluate next steps then.

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

No branches or pull requests

4 participants