Skip to content

Commit 4b7d69d

Browse files
authored
Merge pull request #3 from AstralProtocol/fix-api-section-urls
fix: Update API section URLs to include /api prefix and update docs t…
2 parents 17d22cf + e73fd0f commit 4b7d69d

13 files changed

Lines changed: 74 additions & 23 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
build-and-test:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout repository
15+
uses: actions/checkout@v4
16+
17+
- name: Setup Node.js
18+
uses: actions/setup-node@v4
19+
with:
20+
node-version: '18'
21+
cache: 'npm'
22+
23+
- name: Install dependencies
24+
run: npm ci
25+
26+
- name: Build documentation
27+
run: npm run build
28+
29+
- name: Test build output
30+
run: |
31+
if [ ! -d "build" ]; then
32+
echo "Build directory not found!"
33+
exit 1
34+
fi
35+
echo "✅ Build completed successfully"
36+
echo "📄 Generated files:"
37+
ls -la build/

docs/api/api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: api-reference
33
title: Astral API Reference
44
sidebar_label: API Reference
5-
slug: /api-reference
5+
slug: /api/api-reference
66
---
77

88
# Astral API Reference

docs/api/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: authentication
33
title: Authentication
44
sidebar_label: Authentication
5-
slug: /authentication
5+
slug: /api/authentication
66
---
77

88
# Authentication

docs/api/data-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: data-model
33
title: Data Model
44
sidebar_label: Data Model
5-
slug: /data-model
5+
slug: /api/data-model
66
---
77

88
# Data Model

docs/api/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: getting-started
33
title: Getting Started
44
sidebar_label: Getting Started
5-
slug: /getting-started
5+
slug: /api/getting-started
66
---
77

88
# Getting Started with Astral API

docs/api/index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: introduction
33
title: Astral Protocol API Documentation
44
sidebar_label: Introduction
5-
slug: /docs
5+
slug: /api
66
---
77

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

3636
To start using the Astral API:
3737

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

4242
## Example Use Cases
4343

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

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

6565
## Support and Community
6666

6767
If you have questions or need help:
6868

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

docs/api/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: troubleshooting
33
title: Troubleshooting
44
sidebar_label: Troubleshooting
5-
slug: /troubleshooting
5+
slug: /api/troubleshooting
66
---
77

88
# Troubleshooting Guide

docs/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ A structured way of representing geographic information clearly and consistently
2424

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

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

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

3838

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

4242
A unified interface to the decentralized geospatial web:
4343

docs/sdk/core-concepts/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,4 +291,4 @@ Now that you understand the core concepts:
291291

292292
**Reference materials:**
293293
- **[Location Protocol Specification](https://easierdata.org/updates/2025/2025-05-19-location-protocol-spec)** - Full protocol details
294-
- **[API Reference](/getting-started)** - Complete method documentation
294+
- **[API Reference](/api/getting-started)** - Complete method documentation

docs/sdk/guides/getting-started.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -426,6 +426,20 @@ const point = {
426426
};
427427
```
428428

429+
## Migrating from v0.1.2
430+
431+
### Breaking Changes
432+
None. The API remains the same.
433+
434+
### Improvements
435+
- Enhanced verification capabilities
436+
- Better error handling and messaging
437+
- Performance optimizations
438+
- Additional network support
439+
440+
### Update Your Code
441+
No code changes required from v0.1.2.
442+
429443
## Migrating from v0.1.1
430444

431445
### Breaking Changes

0 commit comments

Comments
 (0)