docs: Clarify locationType and location attribute relationship #6
Conversation
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
Addresses feedback from Philipp via Adam Spiers regarding confusion about the locationType attribute structure: - Changed "included in" to clearly state that locationType IS the Location Format Identifier, not a container that includes it - Added new "How It Works" section explicitly explaining the relationship between locationType and location attributes - Added three concrete examples showing both locationType and location values together for different formats (coordinate, GeoJSON, WKT) - Reorganized content to present the two-attribute structure upfront before diving into identifier naming conventions - Minor whitespace cleanup (trailing space removal) This improves navigation and clarity by making it immediately clear which content applies to locationType (the identifier) vs location (the payload). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Location attestations are consistently-formatted verifiable location records that can optionally carry location proofs (cryptographic/cryptoeconomic evidence). Updated terminology to accurately reflect this distinction. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Changed GitHub links in navbar and footer from AstralProtocol/astralprotocol to AstralProtocol/docs to correctly reference the documentation repository. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
…ions Added comprehensive explanation of why locationType is included and clarified that the location payload can be either direct data or a pointer: - Clarified that location can contain actual data OR pointers (CID, DID, URL) - Added "Why Include locationType?" section explaining: - Efficiency: Avoids blind downloads of large files - Clarity: Resolves ambiguities like coordinate ordering - Interoperability: Enables system coordination without inspecting payloads - Added Example 4 showing pointer usage with IPFS CID for raster data - Updated existing examples to distinguish "Direct data" vs "Pointer" patterns - Noted that verifiable storage (like IPFS) is recommended but not required 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR addresses feedback from Philipp (via Adam Spiers) regarding confusion about the
locationTypeattribute structure in the Location Format Extensions documentation.Key Changes
locationTypeIS the Location Format Identifier - Changed vague "included in" language to explicitly state the attribute contains the identifier itself, not just includes itlocationType(the identifier) andlocation(the payload)locationTypeandlocationvalues together for different formats:Problem Addressed
The original text stated:
This caused confusion because:
locationTypeandlocationwasn't explicitly statedNavigation Improvement
The updated structure makes it immediately clear:
locationType(the format identifier string)location(the actual geospatial data)🤖 Generated with Claude Code