-
Notifications
You must be signed in to change notification settings - Fork 205
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
Rewrite geo
crate documentation.
#619
Conversation
Seems like a big improvement! |
3e971c0
to
9ac5284
Compare
d4f1dd0
to
88e3a16
Compare
d2b1efd
to
da6d302
Compare
//! required to actually use the network grid. | ||
//! - `use-serde`: enable serialisation of geometries using `serde`. | ||
//! | ||
//! ## GeoJSON |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we keep the GeoJSON section?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd wager almost everyone will want to use geo to operate on data derived outside of geo, so I think it's worth including and also simultaneously introducing the context of the geo-types
crate.
Here's some off-the-cuff copy:
geojson, wkt, shapefile, and [other crates](#link to addendum with exhaustive list) which support
geo-types
allow you to usegeo
with your favorite spatial format (insert joke about shapefile).
...Formats that support geo-types
- postgis
- flatgeobuffer
- https://github.com/georust/geozero
- any others???
It's a little tricky because it'd be nice to just gloss over the fact that geo-types exists for users of geo, but in reality, people using these formats may need to build the crate with --feature geo-types
so it'd be good to prime them to look for the word geo-types
in that crate's documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd wager almost everyone will want to use geo to operate on data derived outside of geo
This was my rationale for the original inclusion of the GeoJSON section. I think it's useful to try to explicitly point out the various components of the Geo ecosystem to people as early as possible rather than relying on them to figure it out using the context from the docs.
0af9336
to
fcadbd6
Compare
fcadbd6
to
f16236b
Compare
f16236b
to
401ab11
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just two minor things, but this is a big improvement in clarity overall. Thank you for doing this 👏👏❤️
@michaelkirk @urschrei How do those last few commits look? Very open to suggestions for the Ecosystem section I added |
Copy looks good! Presumably you'll need to plug in actual URL's for the ecosystem links. Thanks for working on this! |
they're linked below. i don't see the markdown link reference feature i'm using used often and am happy to switch to inline links if people prefer that. |
My bad! I thought they were just place holders. I think the link reference is great. |
Lgtm! |
bors r=michaelkirk,urschrei |
Build succeeded: |
CHANGES.md
if knowledge of this change could be valuable to users.Extracted out of #576