Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Deploy Documentation

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
build-and-test:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
cache: 'npm'

- name: Install dependencies
run: npm ci

- name: Build documentation
run: npm run build

- name: Test build output
run: |
if [ ! -d "build" ]; then
echo "Build directory not found!"
exit 1
fi
echo "✅ Build completed successfully"
echo "📄 Generated files:"
ls -la build/
2 changes: 1 addition & 1 deletion docs/api/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: api-reference
title: Astral API Reference
sidebar_label: API Reference
slug: /api-reference
slug: /api/api-reference
---

# Astral API Reference
Expand Down
2 changes: 1 addition & 1 deletion docs/api/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: authentication
title: Authentication
sidebar_label: Authentication
slug: /authentication
slug: /api/authentication
---

# Authentication
Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: data-model
title: Data Model
sidebar_label: Data Model
slug: /data-model
slug: /api/data-model
---

# Data Model
Expand Down
2 changes: 1 addition & 1 deletion docs/api/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: getting-started
title: Getting Started
sidebar_label: Getting Started
slug: /getting-started
slug: /api/getting-started
---

# Getting Started with Astral API
Expand Down
22 changes: 11 additions & 11 deletions docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: introduction
title: Astral Protocol API Documentation
sidebar_label: Introduction
slug: /docs
slug: /api
---

# Astral Protocol API Documentation
Expand Down Expand Up @@ -35,9 +35,9 @@ The Astral API is a RESTful API that provides endpoints for:

To start using the Astral API:

1. Check out the [Getting Started Guide](./getting-started.md) for a quick introduction
2. Read the [API Reference](./api-reference.md) for detailed endpoint information
3. Explore the [Data Model](./data-model.md) to understand location proof structure
1. Check out the [Getting Started Guide](/api/getting-started) for a quick introduction
2. Read the [API Reference](/api/api-reference) for detailed endpoint information
3. Explore the [Data Model](/api/data-model) to understand location proof structure

## Example Use Cases

Expand All @@ -55,18 +55,18 @@ The Astral API enables numerous applications, including:
This documentation is organized into the following sections:

- **Introduction**: Overview of the Astral Protocol API (this page)
- **[Getting Started](./getting-started.md)**: Quick start guide for using the API
- **[API Reference](./api-reference.md)**: Detailed information about all API endpoints
- **[Data Model](./data-model.md)**: Overview of the location proof data model
- **[Spatial Queries](./spatial-queries.md)**: Guide to geographic filtering capabilities
- **[Authentication](./authentication.md)**: Information about authentication (future)
- **[Troubleshooting](./troubleshooting.md)**: Solutions to common issues
- **[Getting Started](/api/getting-started)**: Quick start guide for using the API
- **[API Reference](/api/api-reference)**: Detailed information about all API endpoints
- **[Data Model](/api/data-model)**: Overview of the location proof data model
- **[Spatial Queries](/api/spatial-queries)**: Guide to geographic filtering capabilities
- **[Authentication](/api/authentication)**: Information about authentication (future)
- **[Troubleshooting](/api/troubleshooting)**: Solutions to common issues

## Support and Community

If you have questions or need help:

- Check the [Troubleshooting Guide](./troubleshooting.md) for solutions to common problems
- Check the [Troubleshooting Guide](/api/troubleshooting) for solutions to common problems
- Create an issue in the [GitHub repository](https://github.com/DecentralizedGeo/astral-api)
- Join our community channels for discussion and support

Expand Down
2 changes: 1 addition & 1 deletion docs/api/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: troubleshooting
title: Troubleshooting
sidebar_label: Troubleshooting
slug: /troubleshooting
slug: /api/troubleshooting
---

# Troubleshooting Guide
Expand Down
4 changes: 2 additions & 2 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ A structured way of representing geographic information clearly and consistently

The Astral Spatial Attestation Framework provides a toolkit for developers to build with location data in the Ethereum ecosystem.

#### Astral SDK `beta v0.1.0`
#### Astral SDK `beta v0.1.3`
[SDK Docs →](/sdk)<br/>
[SDK Repo →](https://github.com/DecentralizedGeo/astral-sdk)

Expand All @@ -37,7 +37,7 @@ A TypeScript client library for location-based attestations, now available in be


#### Astral API `live beta`
[API Docs →](/getting-started)
[API Docs →](/api/getting-started)

A unified interface to the decentralized geospatial web:

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/core-concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,4 +291,4 @@ Now that you understand the core concepts:

**Reference materials:**
- **[Location Protocol Specification](https://easierdata.org/updates/2025/2025-05-19-location-protocol-spec)** - Full protocol details
- **[API Reference](/getting-started)** - Complete method documentation
- **[API Reference](/api/getting-started)** - Complete method documentation
14 changes: 14 additions & 0 deletions docs/sdk/guides/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,20 @@ const point = {
};
```

## Migrating from v0.1.2

### Breaking Changes
None. The API remains the same.

### Improvements
- Enhanced verification capabilities
- Better error handling and messaging
- Performance optimizations
- Additional network support

### Update Your Code
No code changes required from v0.1.2.

## Migrating from v0.1.1

### Breaking Changes
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/guides/onchain-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -673,4 +673,4 @@ async function createRestrictedAttestation(
- **[Extension System](/sdk/extensions)** - Custom location formats and media types
- **[Offchain Workflow Guide](offchain-workflow.md)** - Learn about gasless attestations
- **[Examples Cookbook](examples.md)** - Real-world usage patterns
- **[Smart Contract Integration](/getting-started)** - Advanced blockchain patterns
- **[Smart Contract Integration](/api/getting-started)** - Advanced blockchain patterns
4 changes: 2 additions & 2 deletions docs/sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Astral SDK is a developer-friendly TypeScript library that makes location-based
- **[Onchain Workflow](/sdk/guides/onchain-workflow)** - Permanent blockchain records

### § Reference
- **[API Reference](/getting-started)** - Complete method documentation
- **[API Reference](/api/getting-started)** - Complete method documentation
- **[Extensions Guide](/sdk/extensions)** - Extension system overview

## Why Astral SDK?
Expand Down Expand Up @@ -94,5 +94,5 @@ console.log('Attestation UID:', attestation.uid);

1. **New to location attestations?** Start with [Core Concepts](/core-concepts)
2. **Want to build something?** Try the [Getting Started Guide](/sdk/guides/getting-started)
3. **Need reference docs?** See the [API Reference](/getting-started)
3. **Need reference docs?** See the [API Reference](/api/getting-started)
4. **Looking for extensions?** Check the [Extensions Guide](/sdk/extensions)
2 changes: 1 addition & 1 deletion docs/sdk/quick-start/first-attestation.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,5 +116,5 @@ const featureAttestation = await sdk.createOffchainLocationAttestation({
### → Get Help

• Review [common issues](/sdk/guides/getting-started#troubleshooting)
• Check the [API Reference](/getting-started)
• Check the [API Reference](/api/getting-started)
• See [example projects](/examples)