-
Notifications
You must be signed in to change notification settings - Fork 10
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
Broken links to polygons
and geojson
, and toregion
#342
Comments
@rhugonnet Thanks for catching these broken links. I made the fixes in the commit referenced above, and I've rebuilt and redeployed the website. The links to As for places where the documentation says "formats supported by SlideRule", can you specify where you are seeing that? I wasn't able to find that phrase in our documentation, though there are a couple of places that we reference datasets supported by SlideRule. Is that what you are referring to? |
polygons
and geojson
, or subclassed toregion
polygons
and geojson
, and toregion
Thanks @jpswinski! I'll strive to open PRs to make it quicker for you in the future, here I wasn't sure where those links were supposed to go! (I hadn't found the section Core/Parameters"!) 😅 For the wording "formats supported by SlideRule", it was actually only a couple occurences (not sure anything needs to be changed):
I'll keep taking notes if I catch anything as I navigate through the documentation. And then maybe the most efficient way would be to go through all of those together at once, to streamline some sections of the Docs if need be! |
I made a first cut at updating the documentation to make the region format discussion clearer. It isn't deployed to the website yet, but the changes are captured in this commit: 93035cc Hopefully this helps, but I can see how it is confusing, and welcome any suggestions. |
For
polygons
andgeojson
, on this page: https://slideruleearth.io/web/rtd/user_guide/ICESat-2.html#photon-input-parametersI'm not sure what was the intention? I could not find any other specific info on polygons/geojson elsewhere, but it'd indeed be a great resource to have a single place describing this! 🙂 A lot of function mention "formats supported by SlideRule", having the same link in each would help a lot point the user to that list of formats.
For
toregion
: the link here: https://slideruleearth.io/web/rtd/getting_started/Getting-Started.html?highlight=geojson#common-api-calls is pointing to the ICESat-2 API instead of SlideRule API, so doesn't bring to the actual function. Need to be updated!The text was updated successfully, but these errors were encountered: