Skip to content

Comments

docs: information architecture restructure#25

Open
johnx25bd wants to merge 8 commits intomainfrom
docs/information-architecture
Open

docs: information architecture restructure#25
johnx25bd wants to merge 8 commits intomainfrom
docs/information-architecture

Conversation

@johnx25bd
Copy link
Member

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.

  • Rewritten entry pages: introduction, quickstart, how-it-works lead with curl/API, not Solidity
  • 6 concept pages: geocomputation, geographic-features, result-format, privacy-model + edits to verifiable-computation, location-proofs
  • 6 guides: local-development, calling-the-api, blockchain-integration, agent-integration, building-plugins, verifying-location-proofs
  • 4 use cases: delivery-verification, parametric-insurance, geofence-compliance, onchain-attestation
  • 4 trust model pages: architecture, what-is-verified, what-you-are-trusting, security
  • API reference: compute/* and verify/* subdirectories
  • New: sdk/types, resources/research, resources/changelog

Known remaining work

  • ~9 pre-existing pages have old terminology (faq, playground, schemas, sdk/*, api-reference/overview)
  • Original replaced files preserved but not in navigation
  • Highest hallucination risk: agent-integration, building-plugins, verifying-location-proofs, privacy-model

Test plan

  • Review on Mintlify preview
  • Verify navigation links resolve
  • Check code examples against actual API/SDK
  • Flag fabricated claims or incorrect patterns

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant