docs: information architecture restructure#25
Conversation
Adds RESTRUCTURE.md (rationale, audience analysis, migration plan) and mint.proposed.json (new Mintlify navigation config). Key changes: lead with verifiable computation not blockchain, add trust model section, add agent integration as peer path, relocate Ethereum-specific concepts into guides. Terminology aligned with concept-map.md from docs-plan repo.
Replaces mint.json with proposed navigation structure: - Getting Started, Core Concepts, Guides, Use Cases sections - API Reference split into Compute, Verify, Records groups - New Trust Model section - Resources section with research and changelog
- Introduction: lead with verifiable spatial computation, not Ethereum - Quickstart: curl-first approach, 4 clear steps, onchain is optional - How-it-works: rename Policy Engine to Compute Engine, update diagrams Reframes the entry point for a wider audience beyond blockchain developers. Blockchain integration is positioned as one path among several (agents, backends, compliance).
New pages: - geocomputation.mdx (from geospatial-operations, terminology updated) - geographic-features.mdx (from location-attestations, provenance section) - result-format.mdx (from policy-attestations, universal framing) - privacy-model.mdx (new: TEE privacy guarantees and limitations) Edited: - verifiable-computation.mdx (trust model content extracted) - location-proofs.mdx (terminology: geocomputation, signed result) Original files preserved for reference.
New guides: - local-development: Docker, env setup, --env-file startup - calling-the-api: request/response format, input types, errors - blockchain-integration: EAS resolvers, delegated attestations - agent-integration: Python/TS examples, decision-making patterns - building-plugins: PoL plugin interface, Wi-Fi example - verifying-location-proofs: claims, stamps, credibility scores blockchain-integration merges content from eas-resolvers, policy-attestations onchain sections, and location-attestations storage options.
- delivery-verification: escrow + proximity resolver - parametric-insurance: crop insurance with distance threshold - geofence-compliance: drone corridor monitoring - onchain-attestation: NFT minting, token distribution patterns Each page uses story framing with concrete code examples. delivery-verification relocated from guides/ with terminology updates.
Extracted from verifiable-computation.mdx and security.mdx: - architecture: TEE execution model, container design, stateless model - what-is-verified: signature coverage, input references, reproducibility - what-you-are-trusting: honest trust assumptions, GPS spoofing caveat - security: signer address, replay attacks, best practices, key rotation Separates "how it works" from "what you should trust" for clearer reasoning about the system's guarantees.
- api-reference/compute/*: relocate 6 operation pages to subdirectory - api-reference/verify/*: split verify.mdx into stamp, proof, plugins - sdk/types.mdx: TypeScript type definitions reference - resources/research.mdx: links to location proofs paper, research agenda - resources/changelog.mdx: v0.1.0 research preview entry
Code reviewFound 8 issues:
mintlify-docs/api-reference/overview.mdx Lines 146 to 163 in 24edfa8
Lines 489 to 491 in 24edfa8
mintlify-docs/how-it-works.mdx Lines 132 to 134 in 24edfa8
mintlify-docs/use-cases/onchain-attestation.mdx Lines 248 to 250 in 24edfa8
mintlify-docs/api-reference/compute/distance.mdx Lines 14 to 16 in 24edfa8 mintlify-docs/introduction.mdx Lines 44 to 48 in 24edfa8
mintlify-docs/api-reference/overview.mdx Lines 13 to 28 in 24edfa8
mintlify-docs/concepts/result-format.mdx Lines 198 to 200 in 24edfa8
mintlify-docs/resources/schemas.mdx Lines 192 to 194 in 24edfa8 🤖 Generated with Claude Code - If this code review was useful, please react with 👍. Otherwise, react with 👎. |
Rewrite introduction to lead with location proofs first, geocomputation second. Show the full stamp pipeline (collect, create, sign, compose) in both intro and quickstart examples. Reorder Core Concepts in mint.json to follow progressive conceptual build: geographic features → location proofs → geocomputation → result format → verifiable computation → privacy model. Title case all page titles across concepts, guides, use cases, and trust model sections.
Previous version focused exclusively on the TEE/geocomputation side and ignored location proofs. New version walks through the complete pipeline: evidence collection → location proof composition → verification → geocomputation → signed results. Each step explains why it exists, not just what it does. Architecture diagram shows both the location proofs path and geocomputation path as composable but independent capabilities.
Three pages forming a progressive introduction to location data: - location-data: parent page covering verifiability spectrum and data sources - geojson: raw unsigned geometry, when to use it, coordinate conventions - location-records: signed EAS attestations, LP v0.2 schema, storage options Content migrated from geographic-features.mdx and location-attestations.mdx, reorganized to separate concerns and build concepts progressively.
Six pages building the location proof concept progressively: - location-proofs: parent page with certainty spectrum (L0-L5), key principles, and overview of the sub-pages - pol-systems: categories of proof-of-location systems with honest assessment of current state - location-stamps: atomic evidence units, independence from claims - location-claims: assertions with required spatial uncertainty - location-proof-structure: composition, single vs multi-stamp, plugin abstraction layer - location-proof-evaluation: three-phase evaluation, credibility vector, confidence vs probability Rewrites location-proofs.mdx from interface-heavy implementation doc to conceptual explanation. No TypeScript interfaces or code snippets.
Four pages covering the geocomputation layer: - geocomputation: parent page covering computational challenges, scope (verify + compute + future AI/ML), and verifiability approaches (TEE, ZK, smart contracts) - astral-location-services: the hosted TEE service, verifiability and privacy properties, EigenCompute stack, signing key - verify: the verification endpoint pipeline and its relationship to evaluation concepts - compute: geospatial operations, accepted inputs, PostGIS/GEOS, precision/determinism, available and planned operations Rewrites geocomputation.mdx from implementation-heavy to conceptual. New pages separate the service (astral-location-services) from its two capabilities (verify, compute).
Two standalone concept pages completing the Core Concepts section: - signed-results: output formats, offchain and onchain usage, delegated attestation pattern, not every result needs blockchain - privacy: TEE privacy guarantees, information leakage from results, spatial/temporal uncertainty as privacy tools, ZK research direction, honest TEE limitations Content from result-format.mdx, policy-attestations.mdx, and privacy-model.mdx reorganized into conceptual explanations without code snippets or interface definitions.
Replace flat list of 6 concept pages with nested groups that tell a progressive story when scanning the sidebar: Location Data → Location Proofs → Geocomputation → Signed Results → Privacy Each group has sub-pages that build on each other. Readers can scan the sidebar and understand Astral's conceptual model without clicking into any page.
Content migrated to the new Core Concepts structure: - geographic-features → location-data, geojson, location-records - location-attestations → location-records - geospatial-operations → compute - policy-attestations → signed-results - eas-resolvers → removed (resolver patterns in guides) - verifiable-computation → geocomputation, astral-location-services - result-format → signed-results - privacy-model → privacy Also updates quickstart.mdx link to point to new location-data page.
Page-by-page review with hand-crafted edits throughout: - Remove nonexistent confidence score from evaluation page, replace with accurate credibility vector structure from SDK - Fix verify endpoint output (returns VerifiedLocationProof, not just credibility vector) - Fix privacy page: v0 results include input plaintext, added warning and opened astral-location-services#57 - Fix GeoJSON page: Astral v0 accepts bare Geometry only, opened astral-sdk#67 for full spec parity - Rewrite location proofs overview with certainty spectrum, design principles from research paper, neutral framework - Generalize all pages: remove specific plugin references from conceptual content - Render inline comments as callouts throughout - Capitalize section headers consistently - Add nav cards and see-also links to all pages
Summary
Restructures docs from blockchain-first framing ("geospatial policy engine for Ethereum") to wider "verifiable spatial computation" framing. Blockchain is one integration path alongside agents, APIs, and compliance systems.
Known remaining work
Test plan