docs: add geolocation user and contributor documentation (#165)#166
Open
nikw9944 wants to merge 3 commits intoDraft-Potential-Geo-Docsfrom
Open
docs: add geolocation user and contributor documentation (#165)#166nikw9944 wants to merge 3 commits intoDraft-Potential-Geo-Docsfrom
nikw9944 wants to merge 3 commits intoDraft-Potential-Geo-Docsfrom
Conversation
Contributor
Author
Summary of Changes
Testing Verification
🤖 Generated with Claude Code |
Add comprehensive geolocation documentation covering both user and contributor experiences: - geolocation.md: User-facing guide for creating users, managing targets (Outbound, OutboundIcmp, Inbound flows), set-result-destination, and receiving LocationOffset data - contribute-geoprobe.md: Contributor guide for deploying and configuring geoprobe-agents including architecture diagrams, prerequisites, installation, onchain registration, and monitoring - Update glossary with geoProbe, LocationOffset, and Geolocation entries - Update contributor overview documentation structure table - Add pymdownx.tabbed extension to mkdocs.yml for tabbed content support Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
#165) - Rename contribute-geoprobe.md to contribute-geolocation.md - Remove Architecture section from contributor doc (already in user doc) - Mark DZ Ledger recording as a future feature in diagrams and prose - Remove redundant DZD→Probe connection from flow-type comparison diagram - Add RFC 16 reference admonition to user-facing geolocation doc - Update all cross-references (mkdocs.yml, contribute-overview, glossary) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Update glossary Geolocation definition to mark onchain recording as a future feature, consistent with the user-facing geolocation doc. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
nikw9944
force-pushed
the
nikw9944/docs-165
branch
from
0dfb146 to
4021c5f
Compare
ben-dz
requested changes
Apr 15, 2026
| @@ -24,22 +23,24 @@ flowchart LR | |||
| Probe -- "RTT measurement" --> T | |||
| T -- "signed response" --> Probe | |||
There was a problem hiding this comment.
Responses aren't signed. I might do this as a set of arrows for measurement, and then a separate arrow for signed offset.
| All measurements are cryptographically signed and recorded onchain. | ||
| All measurements are cryptographically signed. Onchain recording to the DoubleZero Ledger is planned for a future release. | ||
|
|
||
| **Important:** Geolocation reports RTT only — not inferred distance or coordinates. The speed of light through fiber (~124 miles per millisecond) provides a physical upper bound on how far a device can be from a probe. RTT is not divided by two, since round-trip asymmetry cannot be assumed. How you interpret RTT (e.g., computing a maximum-distance radius) is up to you. |
There was a problem hiding this comment.
"A common method would be to divide the RTT by 2, and then multiply by the speed of light through glass to provide a radius around the DZD coordinates that the target is located within"
|
|
||
| --- | ||
|
|
||
| ## Check your balance |
There was a problem hiding this comment.
Right below here it mentions a cost per probe cycle, which isn't real.
| doublezero-geolocation user get --env testnet --user <your-user-code> | ||
| ``` | ||
|
|
||
| ### Step 4: Run the target sender (inbound flow only) |
There was a problem hiding this comment.
Outbound requires running the "target" application which also has examples.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #165
docs/geolocation.md) covering GeoProbe overview, prerequisites, connecting via CLI/UI, monitoring, and troubleshootingdocs/contribute-geoprobe.md) with architecture, development setup, testing, and deployment proceduresdocs/contribute-overview.md) to link the new GeoProbe contributor pagedocs/glossary.md)Test plan
mkdocs servebuilds without errors