Skip to content

Add location proof plugin documentation#24

Open
johnx25bd wants to merge 3 commits intomainfrom
docs/location-proof-plugins
Open

Add location proof plugin documentation#24
johnx25bd wants to merge 3 commits intomainfrom
docs/location-proof-plugins

Conversation

@johnx25bd
Copy link
Member

Summary

Documents the location proof plugin system — concepts, guides, and API reference.

New pages (6):

  • concepts/location-proofs.mdx — evidence-based verification, terminology, pipeline, credibility scoring
  • concepts/plugins.mdx — plugin interface, registry, runtime model, stamp lifecycle
  • guides/creating-location-proofs.mdx — E2E tutorial with mock plugin
  • guides/proofmode-integration.mdx — proof bundle parsing, PGP verification, signals
  • guides/witnesschain-integration.mdx — historical proofs, ECDSA verification, scoring
  • guides/writing-plugins.mdx — complete guide to implementing LocationProofPlugin

Updated pages (7):

  • introduction.mdx — verification callout, SDK section shows stamps/proofs/verify
  • sdk/overview.mdx — v0.3.0, plugin/stamps/proofs/verify in architecture
  • how-it-works.mdx — updated location verification references
  • concepts/verifiable-computation.mdx — links to plugin system (3 locations)
  • guides/location-gated-nft.mdx — location verification links
  • api-reference/overview.mdx — Verify API endpoints (stamp, proof, plugins)
  • mint.json — navigation updated

Test plan

  • mintlify dev renders all new pages without errors
  • Navigation links work correctly
  • Code snippets are syntactically valid
  • Cross-references between pages resolve

Closes: #21, #23

claude and others added 2 commits February 1, 2026 10:05
- Add rotating 3D ASCII globe to introduction page hero
- Globe uses golden spiral distribution for even particle placement
- Mouse interaction causes particles to shatter/repel away
- Particles smoothly spring back to reform the globe
- Uses gold color scheme matching site branding (#D4A63A)
- Supports touch devices and responsive resizing

https://claude.ai/code/session_01AdzuF7QtsgEpGwi3ju16Wv
New concept pages for location proofs and the plugin architecture.
New guides for creating proofs, ProofMode, WitnessChain, and
writing custom plugins. Updated existing pages to reference the
plugin system instead of "in development" placeholders. Added
Verify API endpoints to the API reference.

New pages:
- concepts/location-proofs.mdx
- concepts/plugins.mdx
- guides/creating-location-proofs.mdx
- guides/proofmode-integration.mdx
- guides/witnesschain-integration.mdx
- guides/writing-plugins.mdx

Updated pages:
- introduction.mdx, how-it-works.mdx, sdk/overview.mdx
- concepts/verifiable-computation.mdx
- guides/location-gated-nft.mdx
- api-reference/overview.mdx
- mint.json (navigation)
---
title: "API Overview"
description: "REST APIs for geospatial operations and location records"
description: "REST APIs for geospatial operations, location verification, and location records"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probalby should emphasize verifiable

| API | Purpose | Base URL |
|-----|---------|----------|
| **Compute API** | Verifiable geospatial operations | `/compute/v0` |
| **Verify API** | Location proof verification | `/verify/v0` |
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reorder, verify shoudl be first, then compute, then records

|-----|---------|----------|
| **Compute API** | Verifiable geospatial operations | `/compute/v0` |
| **Verify API** | Location proof verification | `/verify/v0` |
| **Records API** | Query location attestations | `/api/v0` |
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we make this records/v0, but silently keep api/v0 working under the hood? (api is too catch-all and is confusing)

| **Records API** | Query location attestations | `/api/v0` |

<CardGroup cols={2}>
<CardGroup cols={3}>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

again reorder Verify Compute Records

Stamp verification and proof credibility assessment
</Card>
<Card title="Records API" icon="database" href="/api-reference/records/overview">
Query existing location attestations across chains
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'location records across systems'

Distance, containment, proximity checks with signed attestations
</Card>
<Card title="Verify API" icon="shield-check" href="#verify-api">
Stamp verification and proof credibility assessment
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is jargony, can it be clearer while still being concise and elegant

Update documentation to match actual SDK implementation from PR #54.
The docs were written before final SDK design was settled and contained
several inaccuracies.

Key changes:
- Remove evaluate() from plugin interface (SDK-side evaluation)
- Replace scalar confidence scores with multidimensional CredibilityVector
- Remove caps (0.85) and bonuses - applications define trust models
- Fix API calls: astral.verify.* → astral.stamps.verify() / astral.proofs.verify()
- Update CredibilityVector structure (spatial, temporal, validity, independence)
- Fix hosted verification options syntax

Files updated:
- guides/creating-location-proofs.mdx
- concepts/location-proofs.mdx
- concepts/plugins.mdx
- guides/writing-plugins.mdx
- guides/witnesschain-integration.mdx
- guides/proofmode-integration.mdx
- sdk/overview.mdx
- api-reference/overview.mdx
- introduction.mdx

Verified against astral-sdk PR #54 implementation.
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.

Document Verify API

2 participants