-
Notifications
You must be signed in to change notification settings - Fork 12
[location] Add initial Golioth Location documentation #450
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
Conversation
Adds initial documentation for the Golioth Location service. Signed-off-by: Daniel Mangum <georgedanielmangum@gmail.com>
c0e6fdf
to
5b61b11
Compare
Visit the preview URL for this PR (updated for commit 5b61b11): https://golioth-docs-dev--pr450-app-services-locatio-mmz6exxz.web.app (expires Fri, 21 Mar 2025 20:45:29 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: f53b02bdc98ce6f5593931ec4c339aa96bac84df |
I reviewed the copy but didn't test anything - LGTM! Is there a Pipeline example planned? |
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.
Pure review of copy, LGTM
LGTM as well! |
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.
Looks good! I made a few small suggestions. The topic of using id
is at your discretion. 😄
|
||
### Fleet Location Visualization | ||
|
||
Projects using the Golioth Location service can the location of devices that |
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.
Projects using the Golioth Location service can the location of devices that | |
Projects using the Golioth Location service can display the location of devices that |
|
||
### Use Cases | ||
|
||
Network-based positioning is particularly relevant in the following scenarios. |
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.
Network-based positioning is particularly relevant in the following scenarios. | |
Network-based positioning is particularly relevant in the following scenarios: |
devices can leverage network-based positioning, which is still able to provide | ||
location data with accuracy on the order of tens to hundreds of meters. | ||
|
||
#### Indoor Devices, and Devices in Urban Locations |
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.
#### Indoor Devices, and Devices in Urban Locations | |
#### Indoor Devices and Devices in Urban Locations |
@@ -0,0 +1,39 @@ | |||
--- | |||
id: resolving |
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.
id: resolving |
My preference is to avoid using id unless we have a reason to do so. This can make URL resolution confusing as it overrides the filename.
If we remove this id, the filename can be changed to 2-resolving.md
to achieve the same application-services/location/resolving
url, or leave the filename as is for application-services/location/resolving-location
.
@@ -0,0 +1,35 @@ | |||
--- | |||
id: querying |
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.
id: querying |
See comment on "02-resolving-location.md"
@@ -0,0 +1,103 @@ | |||
--- | |||
id: location |
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.
id: location |
See comment on "02-resolving-location.md"
Adds initial documentation for the Golioth Location service.