From 8d220db6531927ecb06c4c6fadf31ccc407be32a Mon Sep 17 00:00:00 2001 From: JonnieSparkles Date: Wed, 28 Jan 2026 10:29:32 -0500 Subject: [PATCH 01/16] fix(assets): update icon paths to remove '/public' prefix for consistency --- content/apis/ar-io-node/meta.json | 2 +- content/apis/index.mdx | 2 +- content/build/index.mdx | 2 +- content/learn/(introduction)/permaweb.mdx | 2 +- content/sdks/ar-io-sdk/meta.json | 2 +- content/sdks/index.mdx | 2 +- scripts/generate-sdk-docs.ts | 2 +- src/app/[[...slug]]/page.tsx | 14 ++++++-------- src/app/layout.tsx | 6 +++--- 9 files changed, 16 insertions(+), 18 deletions(-) diff --git a/content/apis/ar-io-node/meta.json b/content/apis/ar-io-node/meta.json index bbe1082b2..f25030cf7 100644 --- a/content/apis/ar-io-node/meta.json +++ b/content/apis/ar-io-node/meta.json @@ -1,6 +1,6 @@ { "title": "Ar.io Gateway", - "icon": "/public/brand/ario-white.svg", + "icon": "/brand/ario-white.svg", "pages": [ "...", "data", diff --git a/content/apis/index.mdx b/content/apis/index.mdx index 61209bf0f..9a562c313 100644 --- a/content/apis/index.mdx +++ b/content/apis/index.mdx @@ -13,7 +13,7 @@ Explore the REST APIs available in the ar.io ecosystem. Our services are built w } + icon={ar.io} title="Ar.io Gateway" description="The core gateway software providing access to data on Arweave. Includes data retrieval, ArNS resolution, and network management." href="/apis/ar-io-node" diff --git a/content/build/index.mdx b/content/build/index.mdx index 069ad39d1..6c61602ba 100644 --- a/content/build/index.mdx +++ b/content/build/index.mdx @@ -54,7 +54,7 @@ If you're unfamiliar with Arweave's permanent storage and Ar.io Network we recom href="/sdks/wayfinder" /> } + icon={ar.io SDK} title="Ar.io SDK Reference" description="Complete SDK documentation for interacting with Ar.io Network protocols" href="/sdks/ar-io-sdk" diff --git a/content/learn/(introduction)/permaweb.mdx b/content/learn/(introduction)/permaweb.mdx index a3b6582dd..3fc64afdd 100644 --- a/content/learn/(introduction)/permaweb.mdx +++ b/content/learn/(introduction)/permaweb.mdx @@ -74,7 +74,7 @@ The permaweb operates through a layered system architecture where each component flexDirection: 'column', alignItems: 'center' }}> - ar.io + ar.io ar.io
Decentralized Access diff --git a/content/sdks/ar-io-sdk/meta.json b/content/sdks/ar-io-sdk/meta.json index 8fae894a2..94cefe3a7 100644 --- a/content/sdks/ar-io-sdk/meta.json +++ b/content/sdks/ar-io-sdk/meta.json @@ -1,6 +1,6 @@ { "title": "Ar.io SDK", - "icon": "/public/brand/ario-white.svg", + "icon": "/brand/ario-white.svg", "pages": [ "(ario-contract)", "(ant-contracts)", diff --git a/content/sdks/index.mdx b/content/sdks/index.mdx index 6a9837670..5e9359b90 100644 --- a/content/sdks/index.mdx +++ b/content/sdks/index.mdx @@ -16,7 +16,7 @@ Build powerful applications with our comprehensive suite of SDKs designed for th href="/sdks/turbo-sdk" /> } + icon={ar.io SDK} title="Interact with the Ar.io Network using the Ar.io SDK" description="Access Ar.io Network protocols, manage ArNS names, interact with ANTs, and integrate gateway services" href="/sdks/ar-io-sdk" diff --git a/scripts/generate-sdk-docs.ts b/scripts/generate-sdk-docs.ts index aad8dae29..44698ec1b 100644 --- a/scripts/generate-sdk-docs.ts +++ b/scripts/generate-sdk-docs.ts @@ -21,7 +21,7 @@ const PACKAGES: { description: "TypeScript/JavaScript SDK for interacting with the ar.io ecosystem", sourceUrl: "https://github.com/ar-io/ar-io-sdk", - icon: "/public/brand/ario-white.svg", + icon: "/brand/ario-white.svg", }, // Turbo SDK { diff --git a/src/app/[[...slug]]/page.tsx b/src/app/[[...slug]]/page.tsx index c4bfa42b8..9b2cc0c79 100644 --- a/src/app/[[...slug]]/page.tsx +++ b/src/app/[[...slug]]/page.tsx @@ -108,9 +108,9 @@ export async function generateMetadata(props: { site: "@ar_io_network", }, icons: { - icon: "https://arweave.net/uA4zrhP_ShZ8-QbbKM0XhBQWpXgBpYDhgr6X5f6Ou88g", - shortcut: "https://arweave.net/uA4zrhP_ShZ8-QbbKM0XhBQWpXgBpYDhgr6X5f6Ou88", - apple: "https://arweave.net/uA4zrhP_ShZ8-QbbKM0XhBQWpXgBpYDhgr6X5f6Ou88", + icon: "/brand/favicon.png", + shortcut: "/brand/favicon.png", + apple: "/brand/favicon.png", }, }; } @@ -165,11 +165,9 @@ export async function generateMetadata(props: { site: "@ar_io_network", }, icons: { - icon: "https://arweave.net/uA4zrhP_ShZ8-QbbKM0XhBQWpXgBpYDhgr6X5f6Ou88g", - shortcut: - "https://arweave.net/uA4zrhP_ShZ8-QbbKM0XhBQWpXgBpYDhgr6X5f6Ou88g", - apple: - "https://arweave.net/uA4zrhP_ShZ8-QbbKM0XhBQWpXgBpYDhgr6X5f6Ou88g", + icon: "/brand/favicon.png", + shortcut: "/brand/favicon.png", + apple: "/brand/favicon.png", }, // Add additional metadata for better SEO keywords: pageKeywords, diff --git a/src/app/layout.tsx b/src/app/layout.tsx index c3caa3103..8e534ad0a 100644 --- a/src/app/layout.tsx +++ b/src/app/layout.tsx @@ -21,9 +21,9 @@ export const metadata: Metadata = { description: "Comprehensive documentation for ar.io and the Arweave ecosystem", icons: { - icon: "https://arweave.net/uA4zrhP_ShZ8-QbbKM0XhBQWpXgBpYDhgr6X5f6Ou88", - shortcut: "https://arweave.net/uA4zrhP_ShZ8-QbbKM0XhBQWpXgBpYDhgr6X5f6Ou88", - apple: "https://arweave.net/uA4zrhP_ShZ8-QbbKM0XhBQWpXgBpYDhgr6X5f6Ou88", + icon: "/brand/favicon.png", + shortcut: "/brand/favicon.png", + apple: "/brand/favicon.png", }, }; From 696a2883c179a4336a3ea8b448d89b6192615328 Mon Sep 17 00:00:00 2001 From: JonnieSparkles Date: Wed, 28 Jan 2026 10:32:19 -0500 Subject: [PATCH 02/16] Ar.io SDK -> ar.io SDK --- content/build/access/arns.mdx | 6 ++-- .../working-with-arns/arns-primary-names.mdx | 6 ++-- content/build/index.mdx | 2 +- .../manage/environment-variables.mdx | 2 +- content/sdks/ar-io-sdk/index.mdx | 6 ++-- content/sdks/ar-io-sdk/meta.json | 2 +- content/sdks/index.mdx | 4 +-- public/llms-full.txt | 28 +++++++++---------- redirects.mjs | 2 +- scripts/generate-sdk-docs.ts | 2 +- 10 files changed, 30 insertions(+), 30 deletions(-) diff --git a/content/build/access/arns.mdx b/content/build/access/arns.mdx index 25356cddb..5bfa34c10 100644 --- a/content/build/access/arns.mdx +++ b/content/build/access/arns.mdx @@ -30,9 +30,9 @@ The easiest way to get an ArNS name is via [arns.ar.io](https://arns.ar.io), whi - **[Wander Chrome Extension](https://chrome.google.com/webstore/detail/wander)** - Browser-based registration - **Wander Mobile App** - Register on iOS and Android -- **Ar.io SDK** - Programmatic registration using the `buyRecord` API +- **ar.io SDK** - Programmatic registration using the `buyRecord` API -### Using the Ar.io SDK +### Using the ar.io SDK For developers, you can register ArNS names programmatically: @@ -52,7 +52,7 @@ console.log('Record purchased:', result); ``` - **Learn More:** For a complete list of Ar.io SDK APIs, see the [ArNS SDK Documentation](/sdks/ar-io-sdk/arweave-name-system-arns). + **Learn More:** For a complete list of ar.io SDK APIs, see the [ArNS SDK Documentation](/sdks/ar-io-sdk/arweave-name-system-arns). ## Fetching Data via ArNS diff --git a/content/build/guides/working-with-arns/arns-primary-names.mdx b/content/build/guides/working-with-arns/arns-primary-names.mdx index 1ffdebe19..832dfa653 100644 --- a/content/build/guides/working-with-arns/arns-primary-names.mdx +++ b/content/build/guides/working-with-arns/arns-primary-names.mdx @@ -49,12 +49,12 @@ Create **web3 identity** using ArNS names. Primary names allow you to use human- - **Send tokens to "jonniesparkles"** instead of copying long wallet addresses - **Display friendly names** as usernames when connecting wallets -- **Apps resolve names** to wallet addresses using the Ar.io SDK +- **Apps resolve names** to wallet addresses using the ar.io SDK - **Seamless user experience** with human-readable identifiers ## Basic Integration -### Using the Ar.io SDK +### Using the ar.io SDK **Get a primary name by address:** @@ -101,7 +101,7 @@ console.log(nameData.name); // e.g., "jonniesparkles" **Developer integration:** -- Use the [Ar.io SDK](/sdks/ar-io-sdk/primary-names#getprimaryname) to resolve names +- Use the [ar.io SDK](/sdks/ar-io-sdk/primary-names#getprimaryname) to resolve names - Support primary names in your dApp - Enhance user experience with human-readable identifiers - **Trust identity ownership** - Only name owners can set primary names, ensuring secure verification diff --git a/content/build/index.mdx b/content/build/index.mdx index 6c61602ba..29edc4cd3 100644 --- a/content/build/index.mdx +++ b/content/build/index.mdx @@ -55,7 +55,7 @@ If you're unfamiliar with Arweave's permanent storage and Ar.io Network we recom /> } - title="Ar.io SDK Reference" + title="ar.io SDK Reference" description="Complete SDK documentation for interacting with Ar.io Network protocols" href="/sdks/ar-io-sdk" /> diff --git a/content/build/run-a-gateway/manage/environment-variables.mdx b/content/build/run-a-gateway/manage/environment-variables.mdx index 2fa4d2e0a..f60b199d4 100644 --- a/content/build/run-a-gateway/manage/environment-variables.mdx +++ b/content/build/run-a-gateway/manage/environment-variables.mdx @@ -130,7 +130,7 @@ The main Ar.io Gateway service that handles data retrieval, indexing, and servin | ------------------------------------ | ------ | ------------------- | ------------------------------------------------- | | `ARNS_ROOT_HOST` | string | - | Root hostname for ArNS | | `SANDBOX_PROTOCOL` | string | - | Protocol for sandboxing redirects (http or https) | -| `AR_IO_SDK_LOG_LEVEL` | string | `none` | Ar.io SDK log level | +| `AR_IO_SDK_LOG_LEVEL` | string | `none` | ar.io SDK log level | | `ARNS_CACHE_TYPE` | string | `node` | ArNS cache type | | `ARNS_CACHE_TTL_SECONDS` | number | `86400` | ArNS cache TTL | | `ARNS_CACHE_MAX_KEYS` | number | `10000` | Max ArNS cache keys | diff --git a/content/sdks/ar-io-sdk/index.mdx b/content/sdks/ar-io-sdk/index.mdx index 825c48637..10872d84a 100644 --- a/content/sdks/ar-io-sdk/index.mdx +++ b/content/sdks/ar-io-sdk/index.mdx @@ -8,7 +8,7 @@ import { BookOpen, Code, Settings, Network, Server, Coins } from "lucide-react"; import { Steps, Step } from "fumadocs-ui/components/steps"; import { Callout } from "fumadocs-ui/components/callout"; -The Ar.io SDK provides comprehensive tools for interacting with the Ar.io Network and Arweave ecosystem. Built with TypeScript, it offers type-safe interfaces for ArNS name management, gateway operations, and AO contract interactions. +The ar.io SDK provides comprehensive tools for interacting with the Ar.io Network and Arweave ecosystem. Built with TypeScript, it offers type-safe interfaces for ArNS name management, gateway operations, and AO contract interactions. ## Quick Start @@ -107,7 +107,7 @@ The Ar.io SDK provides comprehensive tools for interacting with the Ar.io Networ - Ar.io SDK Example + ar.io SDK Example -

Ar.io SDK Example

+

ar.io SDK Example

Loading ar.io data...

diff --git a/content/sdks/ar-io-sdk/meta.json b/content/sdks/ar-io-sdk/meta.json index 94cefe3a7..efb116782 100644 --- a/content/sdks/ar-io-sdk/meta.json +++ b/content/sdks/ar-io-sdk/meta.json @@ -1,5 +1,5 @@ { - "title": "Ar.io SDK", + "title": "ar.io SDK", "icon": "/brand/ario-white.svg", "pages": [ "(ario-contract)", diff --git a/content/sdks/index.mdx b/content/sdks/index.mdx index 5e9359b90..cba211b90 100644 --- a/content/sdks/index.mdx +++ b/content/sdks/index.mdx @@ -17,7 +17,7 @@ Build powerful applications with our comprehensive suite of SDKs designed for th /> } - title="Interact with the Ar.io Network using the Ar.io SDK" + title="Interact with the Ar.io Network using the ar.io SDK" description="Access Ar.io Network protocols, manage ArNS names, interact with ANTs, and integrate gateway services" href="/sdks/ar-io-sdk" /> @@ -34,7 +34,7 @@ Build powerful applications with our comprehensive suite of SDKs designed for th Each SDK serves a specific purpose in the ar.io ecosystem: - **Turbo SDK** - For applications that need fast, reliable data uploads to Arweave -- **Ar.io SDK** - For interacting with Ar.io Network smart contracts and services +- **ar.io SDK** - For interacting with Ar.io Network smart contracts and services - **Wayfinder SDK** - For decentralized data access with built-in verification and gateway routing All SDKs are available for both Node.js and browser environments, with TypeScript support included. diff --git a/public/llms-full.txt b/public/llms-full.txt index fbf27d237..9fe0b5e52 100644 --- a/public/llms-full.txt +++ b/public/llms-full.txt @@ -401,9 +401,9 @@ The easiest way to get an ArNS name is via [arns.ar.io](https://arns.ar.io), whi - **[Wander Chrome Extension](https://chrome.google.com/webstore/detail/wander)** - Browser-based registration - **Wander Mobile App** - Register on iOS and Android -- **Ar.io SDK** - Programmatic registration using the `buyRecord` API +- **ar.io SDK** - Programmatic registration using the `buyRecord` API -### Using the Ar.io SDK +### Using the ar.io SDK For developers, you can register ArNS names programmatically: @@ -421,7 +421,7 @@ const result = await ario.buyRecord({ console.log('Record purchased:', result); ``` - **Learn More:** For a complete list of Ar.io SDK APIs, see the [ArNS SDK Documentation](/sdks/ar-io-sdk/arweave-name-system-arns). + **Learn More:** For a complete list of ar.io SDK APIs, see the [ArNS SDK Documentation](/sdks/ar-io-sdk/arweave-name-system-arns). ## Fetching Data via ArNS @@ -4427,12 +4427,12 @@ Create **web3 identity** using ArNS names. Primary names allow you to use human- - **Send tokens to "jonniesparkles"** instead of copying long wallet addresses - **Display friendly names** as usernames when connecting wallets -- **Apps resolve names** to wallet addresses using the Ar.io SDK +- **Apps resolve names** to wallet addresses using the ar.io SDK - **Seamless user experience** with human-readable identifiers ## Basic Integration -### Using the Ar.io SDK +### Using the ar.io SDK **Get a primary name by address:** @@ -4477,7 +4477,7 @@ console.log(nameData.name); // e.g., "jonniesparkles" **Developer integration:** -- Use the [Ar.io SDK](/sdks/ar-io-sdk/primary-names#getprimaryname) to resolve names +- Use the [ar.io SDK](/sdks/ar-io-sdk/primary-names#getprimaryname) to resolve names - Support primary names in your dApp - Enhance user experience with human-readable identifiers - **Trust identity ownership** - Only name owners can set primary names, ensuring secure verification @@ -7479,7 +7479,7 @@ If you're unfamiliar with Arweave's permanent storage and Ar.io Network we recom href="/sdks/wayfinder" /> } - title="Ar.io SDK Reference" + title="ar.io SDK Reference" description="Complete SDK documentation for interacting with Ar.io Network protocols" href="/sdks/ar-io-sdk" /> @@ -8050,7 +8050,7 @@ The main Ar.io Gateway service that handles data retrieval, indexing, and servin | ------------------------------------ | ------ | ------------------- | ------------------------------------------------- | | `ARNS_ROOT_HOST` | string | - | Root hostname for ArNS | | `SANDBOX_PROTOCOL` | string | - | Protocol for sandboxing redirects (http or https) | -| `AR_IO_SDK_LOG_LEVEL` | string | `none` | Ar.io SDK log level | +| `AR_IO_SDK_LOG_LEVEL` | string | `none` | ar.io SDK log level | | `ARNS_CACHE_TYPE` | string | `node` | ArNS cache type | | `ARNS_CACHE_TTL_SECONDS` | number | `86400` | ArNS cache TTL | | `ARNS_CACHE_MAX_KEYS` | number | `10000` | Max ArNS cache keys | @@ -19557,13 +19557,13 @@ const { id: txId } = await ario.increaseVault({ }); ``` -# Ar.io SDK (/sdks/ar-io-sdk) +# ar.io SDK (/sdks/ar-io-sdk) -**For AI and LLM users**: Access the complete Ar.io SDK documentation in plain text +**For AI and LLM users**: Access the complete ar.io SDK documentation in plain text format at [llm.txt](/sdks/ar-io-sdk/llm.txt) for easy consumption by AI agents and language models. -# Ar.io SDK +# ar.io SDK Please refer to the [source code](https://github.com/ar-io/ar-io-sdk) for SDK details. @@ -20328,7 +20328,7 @@ Build powerful applications with our comprehensive suite of SDKs designed for th href="/sdks/turbo-sdk" /> } - title="Interact with the Ar.io Network using the Ar.io SDK" + title="Interact with the Ar.io Network using the ar.io SDK" description="Access Ar.io Network protocols, manage ArNS names, interact with ANTs, and integrate gateway services" href="/sdks/ar-io-sdk" /> @@ -20343,7 +20343,7 @@ Build powerful applications with our comprehensive suite of SDKs designed for th Each SDK serves a specific purpose in the ar.io ecosystem: - **Turbo SDK** - For applications that need fast, reliable data uploads to Arweave -- **Ar.io SDK** - For interacting with Ar.io Network smart contracts and services +- **ar.io SDK** - For interacting with Ar.io Network smart contracts and services - **Wayfinder SDK** - For decentralized data access with built-in verification and gateway routing All SDKs are available for both Node.js and browser environments, with TypeScript support included. @@ -21409,7 +21409,7 @@ Wayfinder supports intelligent caching: The `@ar.io/sdk` package is an optional peer dependency. To use ar.io network gateways, you must explicitly provide an `ario` instance: -**With Ar.io SDK (Recommended):** +**With ar.io SDK (Recommended):** ```bash npm install @ar.io/wayfinder-core @ar.io/sdk yarn add @ar.io/wayfinder-core @ar.io/sdk diff --git a/redirects.mjs b/redirects.mjs index f2bd3dcbd..dc515baa9 100644 --- a/redirects.mjs +++ b/redirects.mjs @@ -12,7 +12,7 @@ const redirects = [ permanent: true, }, - // Ar.io SDK pages + // ar.io SDK pages { source: '/ar-io-sdk', destination: '/sdks/ar-io-sdk', diff --git a/scripts/generate-sdk-docs.ts b/scripts/generate-sdk-docs.ts index 44698ec1b..2123046dc 100644 --- a/scripts/generate-sdk-docs.ts +++ b/scripts/generate-sdk-docs.ts @@ -11,7 +11,7 @@ const PACKAGES: { sourceUrl: string; icon?: string; }[] = [ - // Ar.io SDK + // ar.io SDK { name: "ar-io-sdk", readmeUrl: From 0285fe00d127d8a55cfc585889d8b8058229adb1 Mon Sep 17 00:00:00 2001 From: JonnieSparkles Date: Wed, 28 Jan 2026 10:36:06 -0500 Subject: [PATCH 03/16] Ar.io Documentation -> ar.io Documentation --- README.md | 4 ++-- src/app/[[...slug]]/page.tsx | 8 ++++---- src/app/layout.tsx | 4 ++-- src/components/page-feedback.tsx | 6 +++--- src/lib/layout.shared.tsx | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a8da91fa7..049dd2dbd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Ar.io Documentation +# ar.io Documentation -Ar.io Documentation is a Next.js site built with Fumadocs that hosts the product and developer documentation for the ar.io network and tooling. It contains authored guides, API references, and autogenerated content sourced from scripts in this repository. +ar.io Documentation is a Next.js site built with Fumadocs that hosts the product and developer documentation for the ar.io network and tooling. It contains authored guides, API references, and autogenerated content sourced from scripts in this repository. ## Docs Site diff --git a/src/app/[[...slug]]/page.tsx b/src/app/[[...slug]]/page.tsx index 9b2cc0c79..804e1aa85 100644 --- a/src/app/[[...slug]]/page.tsx +++ b/src/app/[[...slug]]/page.tsx @@ -81,10 +81,10 @@ export async function generateMetadata(props: { // If no page found, return default metadata if (!page) { return { - title: "Ar.io Documentation", + title: "ar.io Documentation", description: "Documentation for ar.io", openGraph: { - title: "Ar.io Documentation", + title: "ar.io Documentation", description: "Documentation for ar.io", type: "website", siteName: "ar.io", @@ -93,13 +93,13 @@ export async function generateMetadata(props: { url: "/meta.png", width: 1200, height: 630, - alt: "Ar.io Documentation", + alt: "ar.io Documentation", }, ], }, twitter: { card: "summary_large_image", - title: "Ar.io Documentation", + title: "ar.io Documentation", description: "Documentation for ar.io", images: [ "/meta.png", diff --git a/src/app/layout.tsx b/src/app/layout.tsx index 8e534ad0a..7972fd26b 100644 --- a/src/app/layout.tsx +++ b/src/app/layout.tsx @@ -15,8 +15,8 @@ const plusJakartaSans = Plus_Jakarta_Sans({ export const metadata: Metadata = { metadataBase: new URL("https://docs.ar.io"), title: { - default: "Ar.io Documentation", - template: "%s | Ar.io Documentation", + default: "ar.io Documentation", + template: "%s | ar.io Documentation", }, description: "Comprehensive documentation for ar.io and the Arweave ecosystem", diff --git a/src/components/page-feedback.tsx b/src/components/page-feedback.tsx index c58b0dd12..dcfe44e9b 100644 --- a/src/components/page-feedback.tsx +++ b/src/components/page-feedback.tsx @@ -13,7 +13,7 @@ interface FeedbackData { async function handleFeedback(pageUrl: string, feedback: FeedbackData) { try { - // Web3Forms configuration - Public access key for Ar.io Documentation feedback + // Web3Forms configuration - Public access key for ar.io Documentation feedback const WEB3FORMS_ACCESS_KEY = "88dab14e-e2f1-47cc-b284-84496d1ddc59"; const WEB3FORMS_ENDPOINT = "https://api.web3forms.com/submit"; @@ -25,7 +25,7 @@ async function handleFeedback(pageUrl: string, feedback: FeedbackData) { feedback.opinion === "good" ? "✅ POSITIVE" : "❌ NEGATIVE"; const subject = `[Ar.io Docs] ${feedbackType} Feedback - ${pageUrl}`; formData.append("subject", subject); - formData.append("from_name", "Ar.io Documentation Feedback"); + formData.append("from_name", "ar.io Documentation Feedback"); // Create a well-formatted email body const timestamp = new Date().toLocaleString("en-US", { @@ -50,7 +50,7 @@ User Feedback: ${feedback.message || "No additional comments provided."} --- -This feedback was submitted through the Ar.io Documentation site. +This feedback was submitted through the ar.io Documentation site. To improve our docs, please consider opening an issue on GitHub. `.trim(); diff --git a/src/lib/layout.shared.tsx b/src/lib/layout.shared.tsx index 39eeab814..7407bd1f2 100644 --- a/src/lib/layout.shared.tsx +++ b/src/lib/layout.shared.tsx @@ -28,7 +28,7 @@ export function baseOptions(pathname?: string): BaseLayoutProps { title: ( <> - Ar.io Documentation + ar.io Documentation ), }, From fcc84ac7f112b1c7f053448062d0256099e4fc8c Mon Sep 17 00:00:00 2001 From: JonnieSparkles Date: Wed, 28 Jan 2026 10:43:15 -0500 Subject: [PATCH 04/16] Ar.io Gateway -> ar.io --- content/apis/ar-io-node/admin.mdx | 18 ++-- content/apis/ar-io-node/arns.mdx | 2 +- content/apis/ar-io-node/gateway.mdx | 8 +- content/apis/ar-io-node/index-querying.mdx | 2 +- content/apis/ar-io-node/index.mdx | 12 +-- content/apis/ar-io-node/meta.json | 2 +- content/apis/index.mdx | 6 +- content/build/access/find-data.mdx | 2 +- content/build/extensions/bundler.mdx | 2 +- content/build/extensions/clickhouse.mdx | 4 +- content/build/extensions/compute-unit.mdx | 2 +- content/build/extensions/grafana.mdx | 2 +- content/build/run-a-gateway/index.mdx | 2 +- .../build/run-a-gateway/join-the-network.mdx | 8 +- .../manage/environment-variables.mdx | 6 +- .../build/run-a-gateway/manage/filters.mdx | 8 +- .../run-a-gateway/manage/index-snapshots.mdx | 6 +- content/build/run-a-gateway/manage/index.mdx | 8 +- .../manage/setting-apex-domain.mdx | 10 +- .../build/run-a-gateway/manage/ssl-certs.mdx | 8 +- .../run-a-gateway/manage/troubleshooting.mdx | 4 +- .../manage/upgrading-a-gateway.mdx | 6 +- .../build/run-a-gateway/manage/x402-setup.mdx | 8 +- content/build/run-a-gateway/quick-start.mdx | 6 +- content/learn/arns/index.mdx | 2 +- content/learn/gateways/architecture.mdx | 2 +- content/learn/gateways/index.mdx | 4 +- content/learn/gateways/x402-payments.mdx | 4 +- content/learn/wayfinder/index.mdx | 4 +- content/learn/wayfinder/use-cases.mdx | 2 +- .../data-retrieval-strategies.mdx | 2 +- public/llms-full.txt | 98 +++++++++---------- 32 files changed, 130 insertions(+), 130 deletions(-) diff --git a/content/apis/ar-io-node/admin.mdx b/content/apis/ar-io-node/admin.mdx index 24f0072d8..07f158f8c 100644 --- a/content/apis/ar-io-node/admin.mdx +++ b/content/apis/ar-io-node/admin.mdx @@ -20,12 +20,12 @@ _openapi: url: '#get-bundle-processing-status' - depth: 2 title: >- - Blocks transactions or data-items so your Ar.io Gateway will not serve + Blocks transactions or data-items so your ar.io Gateway will not serve them. url: >- #blocks-transactions-or-data-items-so-your-ario-gateway-will-not-serve-them - depth: 2 - title: Blocks an ARNS name so your Ar.io Gateway will not serve it. + title: Blocks an ARNS name so your ar.io Gateway will not serve it. url: '#blocks-an-arns-name-so-your-ario-gateway-will-not-serve-it' - depth: 2 title: Unblock an ARNS name. @@ -52,11 +52,11 @@ _openapi: - content: Get bundle processing status id: get-bundle-processing-status - content: >- - Blocks transactions or data-items so your Ar.io Gateway will not serve + Blocks transactions or data-items so your ar.io Gateway will not serve them. id: >- blocks-transactions-or-data-items-so-your-ario-gateway-will-not-serve-them - - content: Blocks an ARNS name so your Ar.io Gateway will not serve it. + - content: Blocks an ARNS name so your ar.io Gateway will not serve it. id: blocks-an-arns-name-so-your-ario-gateway-will-not-serve-it - content: Unblock an ARNS name. id: unblock-an-arns-name @@ -69,7 +69,7 @@ _openapi: contents: - content: >- Get detailed information about the current operational state of your - Ar.io Gateway, including information about any current warnings or + ar.io Gateway, including information about any current warnings or errors. heading: admin-debugging-information - content: >- @@ -97,7 +97,7 @@ _openapi: heading: get-bundle-processing-status - content: > Submits a TX ID/data-item ID or sha-256 content hash for content you - do not want your Ar.io Gateway to serve. Once submitted, your Gateway + do not want your ar.io Gateway to serve. Once submitted, your Gateway will not respond to requests for these transactions or data-items. @@ -106,9 +106,9 @@ _openapi: by your Gateway. heading: >- blocks-transactions-or-data-items-so-your-ario-gateway-will-not-serve-them - - content: Blocks an ARNS name so your Ar.io Gateway will not serve it. + - content: Blocks an ARNS name so your ar.io Gateway will not serve it. heading: blocks-an-arns-name-so-your-ario-gateway-will-not-serve-it - - content: Unblock an ARNS name so your Ar.io Gateway will serve it again. + - content: Unblock an ARNS name so your ar.io Gateway will serve it again. heading: unblock-an-arns-name - content: > Initiates an export of data to Parquet format files. This process runs @@ -128,7 +128,7 @@ _openapi: {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} -Access several password protected features and functions specific to your Ar.io Gateway. +Access several password protected features and functions specific to your ar.io Gateway. \ No newline at end of file diff --git a/content/apis/ar-io-node/arns.mdx b/content/apis/ar-io-node/arns.mdx index 6edd7f34e..8a4e142d0 100644 --- a/content/apis/ar-io-node/arns.mdx +++ b/content/apis/ar-io-node/arns.mdx @@ -13,7 +13,7 @@ _openapi: {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} -Get data from the Ar.io Gateway Arweave Name System +Get data from the ar.io Gateway Arweave Name System \ No newline at end of file diff --git a/content/apis/ar-io-node/gateway.mdx b/content/apis/ar-io-node/gateway.mdx index 3ef95f648..851b6ce45 100644 --- a/content/apis/ar-io-node/gateway.mdx +++ b/content/apis/ar-io-node/gateway.mdx @@ -24,16 +24,16 @@ _openapi: transaction or ArNS-resolved data (e.g., text/html for HTML documents, application/json for JSON documents, application/octet-stream for binary data, etc.). - - content: Get the current health status of the Ar.io Gateway. + - content: Get the current health status of the ar.io Gateway. - content: | - Returns information about the Ar.io Gateway, including: + Returns information about the ar.io Gateway, including: - Gateway wallet address - Process ID - ANS-104 filter configurations - Supported manifest versions - Gateway software release version - content: > - Returns information about Ar.io Gateway peers and Arweave node peers. + Returns information about ar.io Gateway peers and Arweave node peers. For gateways, includes both data and chunk weights used for peer selection. @@ -59,7 +59,7 @@ _openapi: {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} -Operations related to the Ar.io Gateway server itself, including health checks, metrics, and gateway-specific information +Operations related to the ar.io Gateway server itself, including health checks, metrics, and gateway-specific information \ No newline at end of file diff --git a/content/apis/ar-io-node/index-querying.mdx b/content/apis/ar-io-node/index-querying.mdx index b70dad8c5..7bb6a52a5 100644 --- a/content/apis/ar-io-node/index-querying.mdx +++ b/content/apis/ar-io-node/index-querying.mdx @@ -27,7 +27,7 @@ _openapi: {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} -Get data from the Ar.io Gateway index using GQL +Get data from the ar.io Gateway index using GQL \ No newline at end of file diff --git a/content/apis/ar-io-node/index.mdx b/content/apis/ar-io-node/index.mdx index 621acc591..055132dec 100644 --- a/content/apis/ar-io-node/index.mdx +++ b/content/apis/ar-io-node/index.mdx @@ -1,5 +1,5 @@ --- -title: "Ar.io Gateway APIs" +title: "ar.io Gateway APIs" description: "Core gateway software for accessing, caching, and querying data on Arweave" --- @@ -13,11 +13,11 @@ import { FileText, } from "lucide-react"; -The Ar.io Gateway is the core software for the ar.io network, serving the essential responsibility of gateways for accessing, caching, and querying data stored on Arweave. It provides a robust, decentralized infrastructure for interacting with the permanent web. +The ar.io Gateway is the core software for the ar.io network, serving the essential responsibility of gateways for accessing, caching, and querying data stored on Arweave. It provides a robust, decentralized infrastructure for interacting with the permanent web. ## Core Responsibilities -The Ar.io Gateway handles fundamental operations for the Arweave ecosystem: +The ar.io Gateway handles fundamental operations for the Arweave ecosystem: - **Data Access** - Retrieve transaction data, files, and metadata from Arweave - **Caching** - Intelligent caching strategies for improved performance and availability @@ -27,7 +27,7 @@ The Ar.io Gateway handles fundamental operations for the Arweave ecosystem: ## Advanced Features -Beyond basic gateway functionality, Ar.io Gateway includes sophisticated capabilities: +Beyond basic gateway functionality, ar.io Gateway includes sophisticated capabilities: - **Parquet Generation** - Convert Arweave data into optimized Parquet format for analytics - **Data Verification** - Cryptographic verification of data integrity and authenticity @@ -76,7 +76,7 @@ Beyond basic gateway functionality, Ar.io Gateway includes sophisticated capabil /> -## Get Involved with Ar.io Gateways +## Get Involved with ar.io Gateways } - title="Ar.io Gateway" + title="ar.io Gateway" description="The core gateway software providing access to data on Arweave. Includes data retrieval, ArNS resolution, and network management." href="/apis/ar-io-node" /> @@ -26,9 +26,9 @@ Explore the REST APIs available in the ar.io ecosystem. Our services are built w /> -## Ar.io Gateway APIs +## ar.io Gateway APIs -The Ar.io Gateway serves as the primary interface for accessing Arweave data through the ar.io network. Key endpoints include: +The ar.io Gateway serves as the primary interface for accessing Arweave data through the ar.io network. Key endpoints include: - **Data Access** - Retrieve transaction data and files from Arweave - **ArNS Resolution** - Resolve human-readable names to Arweave transaction IDs diff --git a/content/build/access/find-data.mdx b/content/build/access/find-data.mdx index 61a24bb67..985f3fbc1 100644 --- a/content/build/access/find-data.mdx +++ b/content/build/access/find-data.mdx @@ -28,7 +28,7 @@ This separation allows for powerful data discovery while keeping data retrieval - **Goldsky** - `https://arweave-search.goldsky.com/graphql` - High-performance GraphQL service with full data coverage - **Ar.io Gateways:** ar.io gateways support the `/graphql` endpoint, but they + **ar.io Gateways:** ar.io gateways support the `/graphql` endpoint, but they only return data they've indexed. If you're uploading data and want it unbundled and indexed, you can run a gateway and configure it to unbundle your data, or post data items/bundles via the gateway's APIs (recommended). [Learn diff --git a/content/build/extensions/bundler.mdx b/content/build/extensions/bundler.mdx index bb6bdbec5..cff694cef 100644 --- a/content/build/extensions/bundler.mdx +++ b/content/build/extensions/bundler.mdx @@ -1,6 +1,6 @@ --- title: "Bundler" -description: "Learn about the Turbo ANS-104 data item bundler that can be run alongside an Ar.io Gateway to accept and submit data items to Arweave" +description: "Learn about the Turbo ANS-104 data item bundler that can be run alongside an ar.io Gateway to accept and submit data items to Arweave" --- ## Overview diff --git a/content/build/extensions/clickhouse.mdx b/content/build/extensions/clickhouse.mdx index be27cf5f2..c66c028bb 100644 --- a/content/build/extensions/clickhouse.mdx +++ b/content/build/extensions/clickhouse.mdx @@ -19,7 +19,7 @@ Apache Parquet is a columnar storage file format designed for efficient data sto For more information about Parquet, see the [Parquet documentation](https://parquet.apache.org/docs/). -## Current Integration with Ar.io Gateways +## Current Integration with ar.io Gateways In the current ar.io gateway implementation, Parquet and ClickHouse run alongside SQLite rather than replacing it. This parallel architecture allows each database to handle what it does best: @@ -34,7 +34,7 @@ With ClickHouse integration enabled, GraphQL queries are primarily routed to Cli For more information about gateway architecture and data processing, see our [Gateway Architecture](/learn/gateways/architecture) documentation. -## Parquet vs. SQLite in Ar.io Gateways +## Parquet vs. SQLite in ar.io Gateways While SQLite is excellent for transactional workloads and small to medium datasets, it faces challenges with very large datasets: diff --git a/content/build/extensions/compute-unit.mdx b/content/build/extensions/compute-unit.mdx index 01e3ea551..4fada28e6 100644 --- a/content/build/extensions/compute-unit.mdx +++ b/content/build/extensions/compute-unit.mdx @@ -1,6 +1,6 @@ --- title: "AO Compute Unit (CU)" -description: "Steps for deploying an AO Compute Unit (CU) sidecar alongside your Ar.io Gateway." +description: "Steps for deploying an AO Compute Unit (CU) sidecar alongside your ar.io Gateway." --- ## Overview diff --git a/content/build/extensions/grafana.mdx b/content/build/extensions/grafana.mdx index 1ecd811eb..ba4dc1ebd 100644 --- a/content/build/extensions/grafana.mdx +++ b/content/build/extensions/grafana.mdx @@ -1,6 +1,6 @@ --- title: "Grafana" -description: "Comprehensive guide to deploying and configuring Grafana for Ar.io Gateway monitoring and analytics" +description: "Comprehensive guide to deploying and configuring Grafana for ar.io Gateway monitoring and analytics" --- import { Steps, Step } from "fumadocs-ui/components/steps"; diff --git a/content/build/run-a-gateway/index.mdx b/content/build/run-a-gateway/index.mdx index 34a3a4347..82617f7f2 100644 --- a/content/build/run-a-gateway/index.mdx +++ b/content/build/run-a-gateway/index.mdx @@ -5,7 +5,7 @@ description: "Deploy your own ar.io gateway to power the permanent web and earn import { CreditCard, Zap, Shield, Server, Network, DollarSign, Check, Terminal, Globe, Database } from 'lucide-react'; -Join the decentralized network that powers permanent data access. Run your own **Ar.io Gateway** to support the permaweb infrastructure and earn rewards. +Join the decentralized network that powers permanent data access. Run your own **ar.io Gateway** to support the permaweb infrastructure and earn rewards. ## Gateway Options diff --git a/content/build/run-a-gateway/join-the-network.mdx b/content/build/run-a-gateway/join-the-network.mdx index 730393e89..15b46c031 100644 --- a/content/build/run-a-gateway/join-the-network.mdx +++ b/content/build/run-a-gateway/join-the-network.mdx @@ -1,11 +1,11 @@ --- title: "Join the Network" -description: "Register your Ar.io Gateway with the network to start earning rewards" +description: "Register your ar.io Gateway with the network to start earning rewards" --- import { Target, Database, Compass, Users } from 'lucide-react'; -Take control of the permanent web by running your own **Ar.io Gateway**. Join the decentralized network that powers the permaweb and earn rewards for providing infrastructure services. +Take control of the permanent web by running your own **ar.io Gateway**. Join the decentralized network that powers the permaweb and earn rewards for providing infrastructure services. ## Prerequisites @@ -13,7 +13,7 @@ Take control of the permanent web by running your own **Ar.io Gateway**. Join th ### Running Gateway Required - You must have a fully functional Ar.io Gateway running with a custom domain and SSL certificates. + You must have a fully functional ar.io Gateway running with a custom domain and SSL certificates. **Don't have a gateway yet?** Follow our [Production Setup Guide](/build/run-a-gateway/quick-start#production-setup-with-custom-domain) to get your gateway running with proper DNS configuration. @@ -155,7 +155,7 @@ Choose your preferred method to register your gateway: ``` - The wallet file used in the `--wallet-file` parameter must be the same wallet configured in your Ar.io Gateway's `AR_IO_WALLET` environment variable. This ensures your gateway registration is properly linked to your running gateway instance. + The wallet file used in the `--wallet-file` parameter must be the same wallet configured in your ar.io Gateway's `AR_IO_WALLET` environment variable. This ensures your gateway registration is properly linked to your running gateway instance. **Parameter explanations:** diff --git a/content/build/run-a-gateway/manage/environment-variables.mdx b/content/build/run-a-gateway/manage/environment-variables.mdx index f60b199d4..f0d890431 100644 --- a/content/build/run-a-gateway/manage/environment-variables.mdx +++ b/content/build/run-a-gateway/manage/environment-variables.mdx @@ -1,6 +1,6 @@ --- title: "Environment Variables" -description: "Complete reference for all Ar.io Gateway environment variables across all services" +description: "Complete reference for all ar.io Gateway environment variables across all services" --- @@ -10,7 +10,7 @@ description: "Complete reference for all Ar.io Gateway environment variables acr ## Core ar.io Node -The main Ar.io Gateway service that handles data retrieval, indexing, and serving. +The main ar.io Gateway service that handles data retrieval, indexing, and serving. ### Server Configuration @@ -582,4 +582,4 @@ ARNS_ROOT_HOST=your-domain.com ARNS_CACHE_TYPE=redis ``` -This comprehensive reference should help you configure your Ar.io Gateway with the appropriate environment variables for your specific use case. +This comprehensive reference should help you configure your ar.io Gateway with the appropriate environment variables for your specific use case. diff --git a/content/build/run-a-gateway/manage/filters.mdx b/content/build/run-a-gateway/manage/filters.mdx index e5b718064..cac849ecf 100644 --- a/content/build/run-a-gateway/manage/filters.mdx +++ b/content/build/run-a-gateway/manage/filters.mdx @@ -1,19 +1,19 @@ --- title: "Gateway Filters" -description: "Comprehensive guide to configuring Ar.io Gateway filters for efficient data processing and indexing" +description: "Comprehensive guide to configuring ar.io Gateway filters for efficient data processing and indexing" --- import { BarChart3, Database, Package, Cpu } from "lucide-react"; -Configure your Ar.io Gateway to efficiently process and index only the data you need. This comprehensive guide covers advanced filtering techniques, performance optimization, and real-world use cases. +Configure your ar.io Gateway to efficiently process and index only the data you need. This comprehensive guide covers advanced filtering techniques, performance optimization, and real-world use cases. ## Overview -The Ar.io Gateway uses a flexible JSON-based filtering system to control data processing and indexing. The system provides precise control over which bundles are processed and which data items are indexed for querying. +The ar.io Gateway uses a flexible JSON-based filtering system to control data processing and indexing. The system provides precise control over which bundles are processed and which data items are indexed for querying. ## Understanding the Filtering System -The Ar.io Gateway uses two primary filters to control data processing: +The ar.io Gateway uses two primary filters to control data processing: 1. **ANS104_UNBUNDLE_FILTER** - Controls which bundles are processed and unbundled 2. **ANS104_INDEX_FILTER** - Controls which data items from unbundled bundles are indexed for querying diff --git a/content/build/run-a-gateway/manage/index-snapshots.mdx b/content/build/run-a-gateway/manage/index-snapshots.mdx index be0fa74ea..fadbf61d6 100644 --- a/content/build/run-a-gateway/manage/index-snapshots.mdx +++ b/content/build/run-a-gateway/manage/index-snapshots.mdx @@ -1,13 +1,13 @@ --- title: "Importing SQLite Database Snapshots" -description: "Learn how to import SQLite database snapshots to quickly bootstrap your Ar.io Gateway and reduce synchronization time." +description: "Learn how to import SQLite database snapshots to quickly bootstrap your ar.io Gateway and reduce synchronization time." --- ## Overview -One of the challenges of running an Ar.io Gateway is the initial synchronization time as your gateway builds its local index of the Arweave network. This process can take days or even weeks, depending on your hardware and the amount of data you want to index. To accelerate this process, you can import a pre-synchronized SQLite database snapshot that contains transaction and data item records already indexed. +One of the challenges of running an ar.io Gateway is the initial synchronization time as your gateway builds its local index of the Arweave network. This process can take days or even weeks, depending on your hardware and the amount of data you want to index. To accelerate this process, you can import a pre-synchronized SQLite database snapshot that contains transaction and data item records already indexed. -This guide will walk you through the process of importing a database snapshot into your Ar.io Gateway. +This guide will walk you through the process of importing a database snapshot into your ar.io Gateway. The below instructions are designed to be used in a linux environment. Windows and MacOS users must modify the instructions to use the appropriate package manager/ command syntax for their platform. diff --git a/content/build/run-a-gateway/manage/index.mdx b/content/build/run-a-gateway/manage/index.mdx index e87b07d54..955fd8108 100644 --- a/content/build/run-a-gateway/manage/index.mdx +++ b/content/build/run-a-gateway/manage/index.mdx @@ -1,6 +1,6 @@ --- title: "Manage your Gateway" -description: "Comprehensive guides for advanced Ar.io Gateway operations including monitoring, optimization, content moderation, and specialized configurations" +description: "Comprehensive guides for advanced ar.io Gateway operations including monitoring, optimization, content moderation, and specialized configurations" --- import { @@ -15,7 +15,7 @@ import { CreditCard, } from "lucide-react"; -Master the advanced features and configurations of your Ar.io Gateway. These comprehensive guides cover everything from performance optimization to content moderation, helping you run a professional-grade gateway infrastructure. +Master the advanced features and configurations of your ar.io Gateway. These comprehensive guides cover everything from performance optimization to content moderation, helping you run a professional-grade gateway infrastructure. ## Gateway Management @@ -25,7 +25,7 @@ Master the advanced features and configurations of your Ar.io Gateway. These com }> - Step-by-step guide to safely upgrade your Ar.io Gateway to the latest version without losing data or progress. + Step-by-step guide to safely upgrade your ar.io Gateway to the latest version without losing data or progress. @@ -84,7 +84,7 @@ Master the advanced features and configurations of your Ar.io Gateway. These com href="/build/run-a-gateway/manage/environment-variables" icon={} > - Comprehensive reference for all Ar.io Gateway environment variables + Comprehensive reference for all ar.io Gateway environment variables organized by service component.
diff --git a/content/build/run-a-gateway/manage/setting-apex-domain.mdx b/content/build/run-a-gateway/manage/setting-apex-domain.mdx index 3b5380648..d93041be4 100644 --- a/content/build/run-a-gateway/manage/setting-apex-domain.mdx +++ b/content/build/run-a-gateway/manage/setting-apex-domain.mdx @@ -1,9 +1,9 @@ --- title: "Setting Apex Domain Content" -description: "Complete guide to configuring your Ar.io Gateway to serve custom content from the apex domain" +description: "Complete guide to configuring your ar.io Gateway to serve custom content from the apex domain" --- -Configure your Ar.io Gateway to serve custom content from the apex domain instead of the default Arweave network information. This allows you to customize your gateway's root domain with useful information, project details, or any content you wish to share. +Configure your ar.io Gateway to serve custom content from the apex domain instead of the default Arweave network information. This allows you to customize your gateway's root domain with useful information, project details, or any content you wish to share. ## Overview @@ -310,11 +310,11 @@ Perfect for showcasing your gateway service: - My Ar.io Gateway + My ar.io Gateway -

Ar.io Gateway Service

+

ar.io Gateway Service

Reliable gateway infrastructure for the permanent web

  • High availability
  • @@ -348,7 +348,7 @@ Highlight your projects and services: - My Projects - Ar.io Gateway + My Projects - ar.io Gateway

    My Projects

    diff --git a/content/build/run-a-gateway/manage/ssl-certs.mdx b/content/build/run-a-gateway/manage/ssl-certs.mdx index d1709d272..6c6863ef3 100644 --- a/content/build/run-a-gateway/manage/ssl-certs.mdx +++ b/content/build/run-a-gateway/manage/ssl-certs.mdx @@ -1,12 +1,12 @@ --- title: "Automating SSL Certificate Renewal" -description: "Step-by-step guide to configure Certbot with automatic SSL certificate renewal using DNS API for Ar.io Gateway" +description: "Step-by-step guide to configure Certbot with automatic SSL certificate renewal using DNS API for ar.io Gateway" --- import { Tabs, Tab } from 'fumadocs-ui/components/tabs'; import { Step, Steps } from 'fumadocs-ui/components/steps'; -Secure your Ar.io Gateway with automated SSL certificate renewal using Certbot and DNS challenge validation. This guide covers setup for different DNS providers to automatically renew certificates without manual intervention. +Secure your ar.io Gateway with automated SSL certificate renewal using Certbot and DNS challenge validation. This guide covers setup for different DNS providers to automatically renew certificates without manual intervention. ## Overview @@ -18,7 +18,7 @@ Using DNS challenge validation with Certbot allows you to: ## Prerequisites -- A running Ar.io Gateway +- A running ar.io Gateway - Domain name configured with your DNS provider - Administrative access to your server - API access to your DNS provider @@ -269,7 +269,7 @@ After successfully setting up automatic SSL renewal: ### Update Gateway Configuration -Configure your Ar.io Gateway to use the new certificates. Update your gateway's SSL configuration to point to: +Configure your ar.io Gateway to use the new certificates. Update your gateway's SSL configuration to point to: - **Certificate:** `/etc/letsencrypt/live/your-domain.com/fullchain.pem` - **Private Key:** `/etc/letsencrypt/live/your-domain.com/privkey.pem` diff --git a/content/build/run-a-gateway/manage/troubleshooting.mdx b/content/build/run-a-gateway/manage/troubleshooting.mdx index c72cc3460..09375b6bd 100644 --- a/content/build/run-a-gateway/manage/troubleshooting.mdx +++ b/content/build/run-a-gateway/manage/troubleshooting.mdx @@ -1,11 +1,11 @@ --- title: "Troubleshooting" -description: "Comprehensive troubleshooting guide and FAQ for Ar.io Gateway operators, including common issues, failed epoch guidance, and frequently asked questions." +description: "Comprehensive troubleshooting guide and FAQ for ar.io Gateway operators, including common issues, failed epoch guidance, and frequently asked questions." --- import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -Welcome to the comprehensive troubleshooting and FAQ resource for Ar.io Gateway operators. Use the quick lookup table below for fast answers, or browse the detailed sections for in-depth guidance. +Welcome to the comprehensive troubleshooting and FAQ resource for ar.io Gateway operators. Use the quick lookup table below for fast answers, or browse the detailed sections for in-depth guidance. ## Quick Lookup diff --git a/content/build/run-a-gateway/manage/upgrading-a-gateway.mdx b/content/build/run-a-gateway/manage/upgrading-a-gateway.mdx index 62b40a563..ccfe741db 100644 --- a/content/build/run-a-gateway/manage/upgrading-a-gateway.mdx +++ b/content/build/run-a-gateway/manage/upgrading-a-gateway.mdx @@ -1,9 +1,9 @@ --- title: "Upgrading your Gateway" -description: "Step-by-step guide to upgrading your Ar.io Gateway to the latest version safely without losing data or progress" +description: "Step-by-step guide to upgrading your ar.io Gateway to the latest version safely without losing data or progress" --- -To ensure the optimal performance and security of your Ar.io Gateway, it's essential to regularly upgrade to the latest version. Notably, indexed data resides separate from Docker. As a result, neither upgrading the Gateway nor pruning Docker will erase your data or progress. Here's how you can perform the upgrade: +To ensure the optimal performance and security of your ar.io Gateway, it's essential to regularly upgrade to the latest version. Notably, indexed data resides separate from Docker. As a result, neither upgrading the Gateway nor pruning Docker will erase your data or progress. Here's how you can perform the upgrade: ## Prerequisites @@ -324,4 +324,4 @@ docker compose up -d -That's it! Your Ar.io Gateway is now upgraded to the latest version. Ensure to test and verify that everything is functioning as expected. If you encounter any issues, reach out to the [Ar.io community](https://discord.com/invite/HGG52EtTc2) for assistance. +That's it! Your ar.io Gateway is now upgraded to the latest version. Ensure to test and verify that everything is functioning as expected. If you encounter any issues, reach out to the [Ar.io community](https://discord.com/invite/HGG52EtTc2) for assistance. diff --git a/content/build/run-a-gateway/manage/x402-setup.mdx b/content/build/run-a-gateway/manage/x402-setup.mdx index 06576f8b9..f209a2081 100644 --- a/content/build/run-a-gateway/manage/x402-setup.mdx +++ b/content/build/run-a-gateway/manage/x402-setup.mdx @@ -1,6 +1,6 @@ --- title: "x402 Payment Setup" -description: "Complete guide to configuring x402 payment protocol on your Ar.io Gateway for data egress monetization" +description: "Complete guide to configuring x402 payment protocol on your ar.io Gateway for data egress monetization" --- import { Step, Steps } from "fumadocs-ui/components/steps"; @@ -9,7 +9,7 @@ import { Tabs, Tab } from "fumadocs-ui/components/tabs"; import { Card, Cards } from "fumadocs-ui/components/card"; import { TrendingUp, Zap, Settings, Globe } from "lucide-react"; -Learn how to set up x402 payment protocol on your Ar.io Gateway to monetize data egress. For information about what x402 is and how gateways leverage it, see our [x402 Payments guide](/learn/gateways/x402-payments). +Learn how to set up x402 payment protocol on your ar.io Gateway to monetize data egress. For information about what x402 is and how gateways leverage it, see our [x402 Payments guide](/learn/gateways/x402-payments). **Release Requirement**: x402 payments first became available with gateway @@ -19,7 +19,7 @@ Learn how to set up x402 payment protocol on your Ar.io Gateway to monetize data ## Prerequisites -- Running Ar.io Gateway +- Running ar.io Gateway - Administrative access to your server - USDC wallet for receiving payments - API access to x402 payment facilitator @@ -279,7 +279,7 @@ Customize the payment interface: ```bash # Paywall customization -X_402_APP_NAME=My Ar.io Gateway +X_402_APP_NAME=My ar.io Gateway X_402_APP_LOGO=https://example.com/logo.png ``` diff --git a/content/build/run-a-gateway/quick-start.mdx b/content/build/run-a-gateway/quick-start.mdx index 4b682b426..ad015b4d2 100644 --- a/content/build/run-a-gateway/quick-start.mdx +++ b/content/build/run-a-gateway/quick-start.mdx @@ -5,9 +5,9 @@ description: "Get started running ar.io gateway using Docker - minimal setup, ma import { Network, Target, Tag, Settings } from "lucide-react"; - + New to ar.io gateways? Learn more about what they are and how they work at - [Ar.io Gateways](/learn/gateways). + [ar.io Gateways](/learn/gateways). Get your ar.io gateway running in **30 seconds** with Docker. No configuration needed - just run and test. @@ -452,4 +452,4 @@ Your gateway is running! Now you can: /> -**Need more context?** Learn [What is an Ar.io Gateway](/learn/gateways) to understand the full capabilities. +**Need more context?** Learn [What is an ar.io Gateway](/learn/gateways) to understand the full capabilities. diff --git a/content/learn/arns/index.mdx b/content/learn/arns/index.mdx index 894e7943e..17a79c39d 100644 --- a/content/learn/arns/index.mdx +++ b/content/learn/arns/index.mdx @@ -66,7 +66,7 @@ Users can easily reference these friendly names in their browsers, and other app ```mermaid sequenceDiagram participant User - participant Gateway as Ar.io Gateway + participant Gateway as ar.io Gateway participant Registry as ArNS Registry participant ANT as Arweave Name Token participant Arweave diff --git a/content/learn/gateways/architecture.mdx b/content/learn/gateways/architecture.mdx index b085a5c24..5fee9c446 100644 --- a/content/learn/gateways/architecture.mdx +++ b/content/learn/gateways/architecture.mdx @@ -9,7 +9,7 @@ Ar.io gateways are sophisticated data access layers built on top of the Arweave ```mermaid graph TB - subgraph Gateway ["Ar.io Gateway"] + subgraph Gateway ["ar.io Gateway"] ENVOY[Envoy Proxy
    Load Balancer & Routing] API[Core Service
    Gateway API] diff --git a/content/learn/gateways/index.mdx b/content/learn/gateways/index.mdx index 58cbc1742..ffb720591 100644 --- a/content/learn/gateways/index.mdx +++ b/content/learn/gateways/index.mdx @@ -1,12 +1,12 @@ --- -title: "Ar.io Gateways" +title: "ar.io Gateways" description: "Ar.io gateways bridge the Arweave network and applications, providing fast, reliable access to permanent data through specialized infrastructure." --- import { Card, Cards } from "fumadocs-ui/components/card"; import { Building, Download, Shield, Server, CreditCard } from "lucide-react"; -## What Are Ar.io Gateways? +## What Are ar.io Gateways? Ar.io gateways are specialized infrastructure nodes that serve as bridges between the Arweave network and applications. They transform raw Arweave blockchain data into a fast, reliable, and developer-friendly platform for storing and retrieving permanent data. diff --git a/content/learn/gateways/x402-payments.mdx b/content/learn/gateways/x402-payments.mdx index 9495d2dcc..7641e58a9 100644 --- a/content/learn/gateways/x402-payments.mdx +++ b/content/learn/gateways/x402-payments.mdx @@ -45,11 +45,11 @@ sequenceDiagram Gateway-->>Client: Serve requested data ``` -## Ar.io Gateway Integration +## ar.io Gateway Integration Ar.io gateways implement x402 using **USDC (USD Coin) on the Base blockchain** to monetize data egress with per-byte pricing. This integration works seamlessly with the gateway's rate limiting system to provide a complete traffic management and monetization solution. -### Payment Flow in Ar.io Gateways +### Payment Flow in ar.io Gateways 1. **Free Tier Access**: Users consume regular tokens from their rate limit buckets 2. **Rate Limit Exceeded**: When limits are reached, gateway sends 402 Payment Required response diff --git a/content/learn/wayfinder/index.mdx b/content/learn/wayfinder/index.mdx index e1b306bfe..ad9a4df5a 100644 --- a/content/learn/wayfinder/index.mdx +++ b/content/learn/wayfinder/index.mdx @@ -79,7 +79,7 @@ To access content tied to an Arweave Transaction ID (TxId), simply append the Tx ar://qI19W6spw-kzOGl4qUMNp2gwFH2EBfDXOFsjkcNyK9A ``` -Inputting this into a WayFinder-equipped browser will route your request through the right Ar.io Gateway, translating it as per your `Routing Method` settings. +Inputting this into a WayFinder-equipped browser will route your request through the right ar.io Gateway, translating it as per your `Routing Method` settings. ### ArNS Name Resolution @@ -97,7 +97,7 @@ The Wayfinder protocol, along with the WayFinder App, discerns between TxIds and sequenceDiagram participant User participant Wayfinder - participant Gateway as Ar.io Gateway + participant Gateway as ar.io Gateway participant Arweave User->>Wayfinder: ar://ardrive or ar://txid diff --git a/content/learn/wayfinder/use-cases.mdx b/content/learn/wayfinder/use-cases.mdx index 5ea59e7cc..03a739fb1 100644 --- a/content/learn/wayfinder/use-cases.mdx +++ b/content/learn/wayfinder/use-cases.mdx @@ -5,7 +5,7 @@ description: "Explore practical applications of the Wayfinder Protocol across di ## Decentralized Web Hosting with Flexible Access -With Wayfinder, not only can websites be hosted on the Arweave network, but their accessibility is also enhanced. By using the Wayfinder Protocol, web developers can ensure that if a specific Ar.io Gateway is down, the content can still be accessed through another gateway, offering a more reliable and resilient user experience. +With Wayfinder, not only can websites be hosted on the Arweave network, but their accessibility is also enhanced. By using the Wayfinder Protocol, web developers can ensure that if a specific ar.io Gateway is down, the content can still be accessed through another gateway, offering a more reliable and resilient user experience. This is particularly valuable for: diff --git a/content/sdks/wayfinder/wayfinder-core/data-retrieval-strategies.mdx b/content/sdks/wayfinder/wayfinder-core/data-retrieval-strategies.mdx index 35a16901f..d1a946c74 100644 --- a/content/sdks/wayfinder/wayfinder-core/data-retrieval-strategies.mdx +++ b/content/sdks/wayfinder/wayfinder-core/data-retrieval-strategies.mdx @@ -58,7 +58,7 @@ const wayfinder = new Wayfinder({ sequenceDiagram participant Client participant Wayfinder - participant Gateway as Ar.io Gateway + participant Gateway as ar.io Gateway participant Arweave as Arweave Nodes Client->>Wayfinder: request('ar://data-item-id') diff --git a/public/llms-full.txt b/public/llms-full.txt index 9fe0b5e52..128bdf228 100644 --- a/public/llms-full.txt +++ b/public/llms-full.txt @@ -2,13 +2,13 @@ {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} -Access several password protected features and functions specific to your Ar.io Gateway. +Access several password protected features and functions specific to your ar.io Gateway. # ArNS (/apis/ar-io-node/arns) {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} -Get data from the Ar.io Gateway Arweave Name System +Get data from the ar.io Gateway Arweave Name System # Blocks (/apis/ar-io-node/blocks) @@ -40,15 +40,15 @@ Retrieve and interact with Farcaster Frames using Arweave transactions. {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} -Operations related to the Ar.io Gateway server itself, including health checks, metrics, and gateway-specific information +Operations related to the ar.io Gateway server itself, including health checks, metrics, and gateway-specific information # Index Querying (/apis/ar-io-node/index-querying) {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} -Get data from the Ar.io Gateway index using GQL +Get data from the ar.io Gateway index using GQL -# Ar.io Gateway APIs (/apis/ar-io-node) +# ar.io Gateway APIs (/apis/ar-io-node) import { Server, @@ -59,11 +59,11 @@ import { FileText, } from "lucide-react"; -The Ar.io Gateway is the core software for the ar.io network, serving the essential responsibility of gateways for accessing, caching, and querying data stored on Arweave. It provides a robust, decentralized infrastructure for interacting with the permanent web. +The ar.io Gateway is the core software for the ar.io network, serving the essential responsibility of gateways for accessing, caching, and querying data stored on Arweave. It provides a robust, decentralized infrastructure for interacting with the permanent web. ## Core Responsibilities -The Ar.io Gateway handles fundamental operations for the Arweave ecosystem: +The ar.io Gateway handles fundamental operations for the Arweave ecosystem: - **Data Access** - Retrieve transaction data, files, and metadata from Arweave - **Caching** - Intelligent caching strategies for improved performance and availability @@ -73,7 +73,7 @@ The Ar.io Gateway handles fundamental operations for the Arweave ecosystem: ## Advanced Features -Beyond basic gateway functionality, Ar.io Gateway includes sophisticated capabilities: +Beyond basic gateway functionality, ar.io Gateway includes sophisticated capabilities: - **Parquet Generation** - Convert Arweave data into optimized Parquet format for analytics - **Data Verification** - Cryptographic verification of data integrity and authenticity @@ -114,7 +114,7 @@ Beyond basic gateway functionality, Ar.io Gateway includes sophisticated capabil href="/apis/ar-io-node/admin" /> -## Get Involved with Ar.io Gateways +## Get Involved with ar.io Gateways } title="Run a Gateway" @@ -139,7 +139,7 @@ Beyond basic gateway functionality, Ar.io Gateway includes sophisticated capabil 3. **Choose your integration approach** - Direct APIs calls or SDK usage 4. **Consider running a gateway** - Contribute to the network infrastructure -The Ar.io Gateway APIs provide the foundation for building robust, decentralized applications on Arweave with reliable data access and advanced querying capabilities. +The ar.io Gateway APIs provide the foundation for building robust, decentralized applications on Arweave with reliable data access and advanced querying capabilities. # Network (/apis/ar-io-node/network) @@ -172,7 +172,7 @@ Explore the REST APIs available in the ar.io ecosystem. Our services are built w ## Available Services } - title="Ar.io Gateway" + title="ar.io Gateway" description="The core gateway software providing access to data on Arweave. Includes data retrieval, ArNS resolution, and network management." href="/apis/ar-io-node" /> @@ -182,9 +182,9 @@ Explore the REST APIs available in the ar.io ecosystem. Our services are built w href="/apis/turbo" /> -## Ar.io Gateway APIs +## ar.io Gateway APIs -The Ar.io Gateway serves as the primary interface for accessing Arweave data through the ar.io network. Key endpoints include: +The ar.io Gateway serves as the primary interface for accessing Arweave data through the ar.io network. Key endpoints include: - **Data Access** - Retrieve transaction data and files from Arweave - **ArNS Resolution** - Resolve human-readable names to Arweave transaction IDs @@ -619,7 +619,7 @@ This separation allows for powerful data discovery while keeping data retrieval - **arweave.net** - `https://arweave.net/graphql` - Comprehensive indexing of all Arweave data - **Goldsky** - `https://arweave-search.goldsky.com/graphql` - High-performance GraphQL service with full data coverage - **Ar.io Gateways:** ar.io gateways support the `/graphql` endpoint, but they + **ar.io Gateways:** ar.io gateways support the `/graphql` endpoint, but they only return data they've indexed. If you're uploading data and want it unbundled and indexed, you can run a gateway and configure it to unbundle your data, or post data items/bundles via the gateway's APIs (recommended). [Learn @@ -3220,7 +3220,7 @@ Apache Parquet is a columnar storage file format designed for efficient data sto For more information about Parquet, see the [Parquet documentation](https://parquet.apache.org/docs/). -## Current Integration with Ar.io Gateways +## Current Integration with ar.io Gateways In the current ar.io gateway implementation, Parquet and ClickHouse run alongside SQLite rather than replacing it. This parallel architecture allows each database to handle what it does best: @@ -3234,7 +3234,7 @@ With ClickHouse integration enabled, GraphQL queries are primarily routed to Cli For more information about gateway architecture and data processing, see our [Gateway Architecture](/learn/gateways/architecture) documentation. -## Parquet vs. SQLite in Ar.io Gateways +## Parquet vs. SQLite in ar.io Gateways While SQLite is excellent for transactional workloads and small to medium datasets, it faces challenges with very large datasets: @@ -7529,7 +7529,7 @@ Ready to build on the permanent web? Choose your path above and start creating a # Run a Gateway (/build/run-a-gateway) -Join the decentralized network that powers permanent data access. Run your own **Ar.io Gateway** to support the permaweb infrastructure and earn rewards. +Join the decentralized network that powers permanent data access. Run your own **ar.io Gateway** to support the permaweb infrastructure and earn rewards. ## Gateway Options @@ -7626,13 +7626,13 @@ Whether you're exploring gateway capabilities or ready to join the network, we h # Join the Network (/build/run-a-gateway/join-the-network) -Take control of the permanent web by running your own **Ar.io Gateway**. Join the decentralized network that powers the permaweb and earn rewards for providing infrastructure services. +Take control of the permanent web by running your own **ar.io Gateway**. Join the decentralized network that powers the permaweb and earn rewards for providing infrastructure services. ## Prerequisites ### Running Gateway Required - You must have a fully functional Ar.io Gateway running with a custom domain and SSL certificates. + You must have a fully functional ar.io Gateway running with a custom domain and SSL certificates. **Don't have a gateway yet?** Follow our [Production Setup Guide](/build/run-a-gateway/quick-start#production-setup-with-custom-domain) to get your gateway running with proper DNS configuration. @@ -7732,7 +7732,7 @@ Choose your preferred method to register your gateway: --mainnet ``` - The wallet file used in the `--wallet-file` parameter must be the same wallet configured in your Ar.io Gateway's `AR_IO_WALLET` environment variable. This ensures your gateway registration is properly linked to your running gateway instance. + The wallet file used in the `--wallet-file` parameter must be the same wallet configured in your ar.io Gateway's `AR_IO_WALLET` environment variable. This ensures your gateway registration is properly linked to your running gateway instance. **Parameter explanations:** - `--qty 10000000000` - 10,000 ARIO in mARIO (multiply by 1,000,000) @@ -7930,7 +7930,7 @@ curl -X 'PUT' \ ## Core ar.io Node -The main Ar.io Gateway service that handles data retrieval, indexing, and serving. +The main ar.io Gateway service that handles data retrieval, indexing, and serving. ### Server Configuration @@ -8467,19 +8467,19 @@ ARNS_ROOT_HOST=your-domain.com ARNS_CACHE_TYPE=redis ``` -This comprehensive reference should help you configure your Ar.io Gateway with the appropriate environment variables for your specific use case. +This comprehensive reference should help you configure your ar.io Gateway with the appropriate environment variables for your specific use case. # Gateway Filters (/build/run-a-gateway/manage/filters) -Configure your Ar.io Gateway to efficiently process and index only the data you need. This comprehensive guide covers advanced filtering techniques, performance optimization, and real-world use cases. +Configure your ar.io Gateway to efficiently process and index only the data you need. This comprehensive guide covers advanced filtering techniques, performance optimization, and real-world use cases. ## Overview -The Ar.io Gateway uses a flexible JSON-based filtering system to control data processing and indexing. The system provides precise control over which bundles are processed and which data items are indexed for querying. +The ar.io Gateway uses a flexible JSON-based filtering system to control data processing and indexing. The system provides precise control over which bundles are processed and which data items are indexed for querying. ## Understanding the Filtering System -The Ar.io Gateway uses two primary filters to control data processing: +The ar.io Gateway uses two primary filters to control data processing: 1. **ANS104_UNBUNDLE_FILTER** - Controls which bundles are processed and unbundled 2. **ANS104_INDEX_FILTER** - Controls which data items from unbundled bundles are indexed for querying @@ -9170,9 +9170,9 @@ Now that you understand gateway filtering, continue building your infrastructure ## Overview -One of the challenges of running an Ar.io Gateway is the initial synchronization time as your gateway builds its local index of the Arweave network. This process can take days or even weeks, depending on your hardware and the amount of data you want to index. To accelerate this process, you can import a pre-synchronized SQLite database snapshot that contains transaction and data item records already indexed. +One of the challenges of running an ar.io Gateway is the initial synchronization time as your gateway builds its local index of the Arweave network. This process can take days or even weeks, depending on your hardware and the amount of data you want to index. To accelerate this process, you can import a pre-synchronized SQLite database snapshot that contains transaction and data item records already indexed. -This guide will walk you through the process of importing a database snapshot into your Ar.io Gateway. +This guide will walk you through the process of importing a database snapshot into your ar.io Gateway. The below instructions are designed to be used in a linux environment. Windows and MacOS users must modify the instructions to use the appropriate package manager/ command syntax for their platform. @@ -9370,7 +9370,7 @@ You can also use the [Grafana Extension](/build/extensions/grafana) to view the # Manage your Gateway (/build/run-a-gateway/manage) -Master the advanced features and configurations of your Ar.io Gateway. These comprehensive guides cover everything from performance optimization to content moderation, helping you run a professional-grade gateway infrastructure. +Master the advanced features and configurations of your ar.io Gateway. These comprehensive guides cover everything from performance optimization to content moderation, helping you run a professional-grade gateway infrastructure. ## Gateway Management @@ -9378,7 +9378,7 @@ Master the advanced features and configurations of your Ar.io Gateway. These com Learn how to import pre-synchronized database snapshots to quickly bootstrap your gateway and reduce initial sync time from weeks to hours. }> - Step-by-step guide to safely upgrade your Ar.io Gateway to the latest version without losing data or progress. + Step-by-step guide to safely upgrade your ar.io Gateway to the latest version without losing data or progress. ## Monitoring & Analytics @@ -9406,7 +9406,7 @@ Master the advanced features and configurations of your Ar.io Gateway. These com } > - Comprehensive reference for all Ar.io Gateway environment variables + Comprehensive reference for all ar.io Gateway environment variables organized by service component. ## Support & Troubleshooting @@ -9418,7 +9418,7 @@ Master the advanced features and configurations of your Ar.io Gateway. These com # Setting Apex Domain Content (/build/run-a-gateway/manage/setting-apex-domain) -Configure your Ar.io Gateway to serve custom content from the apex domain instead of the default Arweave network information. This allows you to customize your gateway's root domain with useful information, project details, or any content you wish to share. +Configure your ar.io Gateway to serve custom content from the apex domain instead of the default Arweave network information. This allows you to customize your gateway's root domain with useful information, project details, or any content you wish to share. ## Overview @@ -9648,9 +9648,9 @@ Perfect for showcasing your gateway service: ```html - My Ar.io Gateway + My ar.io Gateway - Ar.io Gateway Service + ar.io Gateway Service Reliable gateway infrastructure for the permanent web High availability @@ -9677,7 +9677,7 @@ Highlight your projects and services: ```html - My Projects - Ar.io Gateway + My Projects - ar.io Gateway My Projects @@ -9938,7 +9938,7 @@ If you encounter issues: # Automating SSL Certificate Renewal (/build/run-a-gateway/manage/ssl-certs) -Secure your Ar.io Gateway with automated SSL certificate renewal using Certbot and DNS challenge validation. This guide covers setup for different DNS providers to automatically renew certificates without manual intervention. +Secure your ar.io Gateway with automated SSL certificate renewal using Certbot and DNS challenge validation. This guide covers setup for different DNS providers to automatically renew certificates without manual intervention. ## Overview @@ -9950,7 +9950,7 @@ Using DNS challenge validation with Certbot allows you to: ## Prerequisites -- A running Ar.io Gateway +- A running ar.io Gateway - Domain name configured with your DNS provider - Administrative access to your server - API access to your DNS provider @@ -10157,7 +10157,7 @@ After successfully setting up automatic SSL renewal: ### Update Gateway Configuration -Configure your Ar.io Gateway to use the new certificates. Update your gateway's SSL configuration to point to: +Configure your ar.io Gateway to use the new certificates. Update your gateway's SSL configuration to point to: - **Certificate:** `/etc/letsencrypt/live/your-domain.com/fullchain.pem` - **Private Key:** `/etc/letsencrypt/live/your-domain.com/privkey.pem` @@ -10204,7 +10204,7 @@ With SSL certificates automated, consider: # Troubleshooting (/build/run-a-gateway/manage/troubleshooting) -Welcome to the comprehensive troubleshooting and FAQ resource for Ar.io Gateway operators. Use the quick lookup table below for fast answers, or browse the detailed sections for in-depth guidance. +Welcome to the comprehensive troubleshooting and FAQ resource for ar.io Gateway operators. Use the quick lookup table below for fast answers, or browse the detailed sections for in-depth guidance. ## Quick Lookup @@ -10515,7 +10515,7 @@ If you encounter any issues during the troubleshooting process, please seek assi # Upgrading your Gateway (/build/run-a-gateway/manage/upgrading-a-gateway) -To ensure the optimal performance and security of your Ar.io Gateway, it's essential to regularly upgrade to the latest version. Notably, indexed data resides separate from Docker. As a result, neither upgrading the Gateway nor pruning Docker will erase your data or progress. Here's how you can perform the upgrade: +To ensure the optimal performance and security of your ar.io Gateway, it's essential to regularly upgrade to the latest version. Notably, indexed data resides separate from Docker. As a result, neither upgrading the Gateway nor pruning Docker will erase your data or progress. Here's how you can perform the upgrade: ## Prerequisites @@ -10689,12 +10689,12 @@ sudo docker compose up -d docker compose up -d ``` -That's it! Your Ar.io Gateway is now upgraded to the latest version. Ensure to test and verify that everything is functioning as expected. If you encounter any issues, reach out to the [Ar.io community](https://discord.com/invite/HGG52EtTc2) for assistance. +That's it! Your ar.io Gateway is now upgraded to the latest version. Ensure to test and verify that everything is functioning as expected. If you encounter any issues, reach out to the [Ar.io community](https://discord.com/invite/HGG52EtTc2) for assistance. # Installation & Setup (/build/run-a-gateway/quick-start) New to ar.io gateways? Learn more about what they are and how they work at - [Ar.io Gateways](/learn/gateways). + [ar.io Gateways](/learn/gateways). Get your ar.io gateway running in **30 seconds** with Docker. No configuration needed - just run and test. @@ -11077,7 +11077,7 @@ Your gateway is running! Now you can: } /> -**Need more context?** Learn [What is an Ar.io Gateway](/learn/gateways) to understand the full capabilities. +**Need more context?** Learn [What is an ar.io Gateway](/learn/gateways) to understand the full capabilities. # Advanced Uploading with Turbo (/build/upload/advanced-uploading-with-turbo) @@ -13222,7 +13222,7 @@ Users can easily reference these friendly names in their browsers, and other app ```mermaid sequenceDiagram participant User - participant Gateway as Ar.io Gateway + participant Gateway as ar.io Gateway participant Registry as ArNS Registry participant ANT as Arweave Name Token participant Arweave @@ -13548,7 +13548,7 @@ Ar.io gateways are sophisticated data access layers built on top of the Arweave ```mermaid graph TB - subgraph Gateway ["Ar.io Gateway"] + subgraph Gateway ["ar.io Gateway"] ENVOY[Envoy ProxyLoad Balancer & Routing] API[Core ServiceGateway API] @@ -14034,9 +14034,9 @@ By joining the network, gateways become part of a collaborative ecosystem that r } /> -# Ar.io Gateways (/learn/gateways) +# ar.io Gateways (/learn/gateways) -## What Are Ar.io Gateways? +## What Are ar.io Gateways? Ar.io gateways are specialized infrastructure nodes that serve as bridges between the Arweave network and applications. They transform raw Arweave blockchain data into a fast, reliable, and developer-friendly platform for storing and retrieving permanent data. @@ -15255,7 +15255,7 @@ To access content tied to an Arweave Transaction ID (TxId), simply append the Tx ar://qI19W6spw-kzOGl4qUMNp2gwFH2EBfDXOFsjkcNyK9A ``` -Inputting this into a WayFinder-equipped browser will route your request through the right Ar.io Gateway, translating it as per your `Routing Method` settings. +Inputting this into a WayFinder-equipped browser will route your request through the right ar.io Gateway, translating it as per your `Routing Method` settings. ### ArNS Name Resolution @@ -15273,7 +15273,7 @@ The Wayfinder protocol, along with the WayFinder App, discerns between TxIds and sequenceDiagram participant User participant Wayfinder - participant Gateway as Ar.io Gateway + participant Gateway as ar.io Gateway participant Arweave User->>Wayfinder: ar://ardrive or ar://txid @@ -15486,7 +15486,7 @@ function WayfinderImage({ txId }: { txId: string }) { ## Decentralized Web Hosting with Flexible Access -With Wayfinder, not only can websites be hosted on the Arweave network, but their accessibility is also enhanced. By using the Wayfinder Protocol, web developers can ensure that if a specific Ar.io Gateway is down, the content can still be accessed through another gateway, offering a more reliable and resilient user experience. +With Wayfinder, not only can websites be hosted on the Arweave network, but their accessibility is also enhanced. By using the Wayfinder Protocol, web developers can ensure that if a specific ar.io Gateway is down, the content can still be accessed through another gateway, offering a more reliable and resilient user experience. This is particularly valuable for: From 7d06757a07102dfe89493011fdf20b4ba05630ce Mon Sep 17 00:00:00 2001 From: JonnieSparkles Date: Wed, 28 Jan 2026 10:47:06 -0500 Subject: [PATCH 05/16] Ar.ioSDK -> ar.io --- content/sdks/ar-io-sdk/index.mdx | 2 +- scripts/generate-sdk-docs.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/sdks/ar-io-sdk/index.mdx b/content/sdks/ar-io-sdk/index.mdx index 10872d84a..c02828942 100644 --- a/content/sdks/ar-io-sdk/index.mdx +++ b/content/sdks/ar-io-sdk/index.mdx @@ -1,5 +1,5 @@ --- -title: "Ar.ioSDK" +title: "ar.io SDK" description: "JavaScript/TypeScript SDK for interacting with the Ar.io Network, including ArNS name management, gateway interactions, and AO contract operations" --- diff --git a/scripts/generate-sdk-docs.ts b/scripts/generate-sdk-docs.ts index 2123046dc..b97f32b5c 100644 --- a/scripts/generate-sdk-docs.ts +++ b/scripts/generate-sdk-docs.ts @@ -17,7 +17,7 @@ const PACKAGES: { readmeUrl: "https://raw.githubusercontent.com/ar-io/ar-io-sdk/alpha/README.md", dest: path.resolve("content/sdks/ar-io-sdk"), - title: "Ar.ioSDK", + title: "ar.io SDK", description: "TypeScript/JavaScript SDK for interacting with the ar.io ecosystem", sourceUrl: "https://github.com/ar-io/ar-io-sdk", From 586aa135b2f2fc7c2199451b5d23637c8b8b736b Mon Sep 17 00:00:00 2001 From: JonnieSparkles Date: Wed, 28 Jan 2026 11:00:00 -0500 Subject: [PATCH 06/16] feat(theme): add ThemeIcon component for theme-aware icons and integrate into source handling --- src/components/theme-icon.tsx | 47 +++++++++++++++++++++++++++++++++++ src/lib/source.ts | 24 +++++++++++++++--- 2 files changed, 68 insertions(+), 3 deletions(-) create mode 100644 src/components/theme-icon.tsx diff --git a/src/components/theme-icon.tsx b/src/components/theme-icon.tsx new file mode 100644 index 000000000..c044ea872 --- /dev/null +++ b/src/components/theme-icon.tsx @@ -0,0 +1,47 @@ +'use client'; + +import { useTheme } from 'next-themes'; +import Image from 'next/image'; +import { useEffect, useState, memo } from 'react'; + +interface ThemeIconProps { + lightSrc: string; + darkSrc: string; + alt?: string; + width?: number; + height?: number; + className?: string; +} + +function ThemeIconComponent({ + lightSrc, + darkSrc, + alt = '', + width = 16, + height = 16, + className = 'size-4' +}: ThemeIconProps) { + const { resolvedTheme } = useTheme(); + const [iconSrc, setIconSrc] = useState(lightSrc); // Default to light logo + + useEffect(() => { + // Update icon after theme is resolved + setIconSrc(resolvedTheme === 'dark' ? darkSrc : lightSrc); + }, [resolvedTheme, lightSrc, darkSrc]); + + return ( + {alt} + ); +} + +// Memoize to prevent unnecessary re-renders +const MemoizedThemeIcon = memo(ThemeIconComponent); + +// Export as a component that can be used with createElement +export const ThemeIcon = MemoizedThemeIcon; diff --git a/src/lib/source.ts b/src/lib/source.ts index 09fc5267e..1170864c7 100644 --- a/src/lib/source.ts +++ b/src/lib/source.ts @@ -2,8 +2,9 @@ import { docs } from "@/.source"; import { loader } from "fumadocs-core/source"; import { transformerOpenAPI } from 'fumadocs-openapi/server'; import { icons } from 'lucide-react'; -import { createElement } from 'react'; +import { createElement, type ReactElement } from 'react'; import Image from 'next/image'; +import { ThemeIcon } from '@/components/theme-icon'; // See https://fumadocs.vercel.app/docs/headless/source-api for more info export const source = loader({ @@ -20,13 +21,30 @@ export const source = loader({ // Handle custom SVG/PNG icons if (typeof icon === 'string' && (icon.endsWith('.svg') || icon.endsWith('.png'))) { - return createElement(Image, { + // Special handling for ar.io SDK icon - use theme-aware component + if (icon === '/brand/ario-white.svg') { + return createElement(ThemeIcon, { + lightSrc: '/brand/ario-black.svg', + darkSrc: '/brand/ario-white.svg', + alt: '', + width: 16, + height: 16, + className: 'size-4' + }); + } + + // For other icons, use Image component directly + // Wrap in a span to provide a stable container that can help with key warnings + return createElement('span', { + key: icon, + style: { display: 'inline-flex', alignItems: 'center' } + }, createElement(Image, { src: icon, alt: '', width: 16, height: 16, className: 'size-4' - }); + })); } // Handle lucide-react icons From d847125eb6ef609e5ffebb3540a24c3efe3047a7 Mon Sep 17 00:00:00 2001 From: JonnieSparkles Date: Wed, 28 Jan 2026 11:00:10 -0500 Subject: [PATCH 07/16] fix(docs): correct terminology from 'milli-ARIO' to 'micro-ARIO' in token conversion documentation --- content/sdks/ar-io-sdk/llm.txt | 2 +- content/sdks/ar-io-sdk/token-conversion.mdx | 2 +- public/llms-full.txt | 2 +- public/sdks/ar-io-sdk/llm.txt | 2 +- src/lib/source.ts | 8 ++++++-- 5 files changed, 10 insertions(+), 6 deletions(-) diff --git a/content/sdks/ar-io-sdk/llm.txt b/content/sdks/ar-io-sdk/llm.txt index 1da53fd9c..c747bd237 100644 --- a/content/sdks/ar-io-sdk/llm.txt +++ b/content/sdks/ar-io-sdk/llm.txt @@ -2868,7 +2868,7 @@ In the example above, the query will return ArNS records where: # Token Conversion (/token-conversion) -The ARIO process stores all values as mARIO (milli-ARIO) to avoid floating-point arithmetic issues. The SDK provides an `ARIOToken` and `mARIOToken` classes to handle the conversion between ARIO and mARIO, along with rounding logic for precision. +The ARIO process stores all values as mARIO (micro-ARIO) to avoid floating-point arithmetic issues. The SDK provides an `ARIOToken` and `mARIOToken` classes to handle the conversion between ARIO and mARIO, along with rounding logic for precision. **All process interactions expect values in mARIO. If numbers are provided as inputs, they are assumed to be in raw mARIO values.** diff --git a/content/sdks/ar-io-sdk/token-conversion.mdx b/content/sdks/ar-io-sdk/token-conversion.mdx index 2df9551ed..f09afc521 100644 --- a/content/sdks/ar-io-sdk/token-conversion.mdx +++ b/content/sdks/ar-io-sdk/token-conversion.mdx @@ -3,7 +3,7 @@ title: "Token Conversion" description: "TypeScript/JavaScript SDK for interacting with the ar.io ecosystem" --- -The ARIO process stores all values as mARIO (milli-ARIO) to avoid floating-point arithmetic issues. The SDK provides an `ARIOToken` and `mARIOToken` classes to handle the conversion between ARIO and mARIO, along with rounding logic for precision. +The ARIO process stores all values as mARIO (micro-ARIO) to avoid floating-point arithmetic issues. The SDK provides an `ARIOToken` and `mARIOToken` classes to handle the conversion between ARIO and mARIO, along with rounding logic for precision. **All process interactions expect values in mARIO. If numbers are provided as inputs, they are assumed to be in raw mARIO values.** diff --git a/public/llms-full.txt b/public/llms-full.txt index 128bdf228..71a23551a 100644 --- a/public/llms-full.txt +++ b/public/llms-full.txt @@ -19704,7 +19704,7 @@ In the example above, the query will return ArNS records where: # Token Conversion (/sdks/ar-io-sdk/token-conversion) -The ARIO process stores all values as mARIO (milli-ARIO) to avoid floating-point arithmetic issues. The SDK provides an `ARIOToken` and `mARIOToken` classes to handle the conversion between ARIO and mARIO, along with rounding logic for precision. +The ARIO process stores all values as mARIO (micro-ARIO) to avoid floating-point arithmetic issues. The SDK provides an `ARIOToken` and `mARIOToken` classes to handle the conversion between ARIO and mARIO, along with rounding logic for precision. **All process interactions expect values in mARIO. If numbers are provided as inputs, they are assumed to be in raw mARIO values.** diff --git a/public/sdks/ar-io-sdk/llm.txt b/public/sdks/ar-io-sdk/llm.txt index 1da53fd9c..c747bd237 100644 --- a/public/sdks/ar-io-sdk/llm.txt +++ b/public/sdks/ar-io-sdk/llm.txt @@ -2868,7 +2868,7 @@ In the example above, the query will return ArNS records where: # Token Conversion (/token-conversion) -The ARIO process stores all values as mARIO (milli-ARIO) to avoid floating-point arithmetic issues. The SDK provides an `ARIOToken` and `mARIOToken` classes to handle the conversion between ARIO and mARIO, along with rounding logic for precision. +The ARIO process stores all values as mARIO (micro-ARIO) to avoid floating-point arithmetic issues. The SDK provides an `ARIOToken` and `mARIOToken` classes to handle the conversion between ARIO and mARIO, along with rounding logic for precision. **All process interactions expect values in mARIO. If numbers are provided as inputs, they are assumed to be in raw mARIO values.** diff --git a/src/lib/source.ts b/src/lib/source.ts index 1170864c7..a3ddb659f 100644 --- a/src/lib/source.ts +++ b/src/lib/source.ts @@ -23,14 +23,18 @@ export const source = loader({ if (typeof icon === 'string' && (icon.endsWith('.svg') || icon.endsWith('.png'))) { // Special handling for ar.io SDK icon - use theme-aware component if (icon === '/brand/ario-white.svg') { - return createElement(ThemeIcon, { + // Wrap in a span to provide a stable container that can help with key warnings + return createElement('span', { + key: icon, + style: { display: 'inline-flex', alignItems: 'center' } + }, createElement(ThemeIcon, { lightSrc: '/brand/ario-black.svg', darkSrc: '/brand/ario-white.svg', alt: '', width: 16, height: 16, className: 'size-4' - }); + })); } // For other icons, use Image component directly From f05e81392049590031184d0631abb61afb1d594a Mon Sep 17 00:00:00 2001 From: JonnieSparkles Date: Wed, 28 Jan 2026 11:01:51 -0500 Subject: [PATCH 08/16] Ar.io Docs -> ar.io --- content/meta.json | 2 +- src/components/page-feedback.tsx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/meta.json b/content/meta.json index 2c5764281..5c08d3174 100644 --- a/content/meta.json +++ b/content/meta.json @@ -1,5 +1,5 @@ { - "title": "Ar.io Docs", + "title": "ar.io Docs", "root": true, "pages": ["...", "learn", "build", "sdks", "apis", "guides", "!migrated"] } diff --git a/src/components/page-feedback.tsx b/src/components/page-feedback.tsx index dcfe44e9b..2eedbfe24 100644 --- a/src/components/page-feedback.tsx +++ b/src/components/page-feedback.tsx @@ -23,7 +23,7 @@ async function handleFeedback(pageUrl: string, feedback: FeedbackData) { // Format the subject for easy email filtering const feedbackType = feedback.opinion === "good" ? "✅ POSITIVE" : "❌ NEGATIVE"; - const subject = `[Ar.io Docs] ${feedbackType} Feedback - ${pageUrl}`; + const subject = `[ar.io Docs] ${feedbackType} Feedback - ${pageUrl}`; formData.append("subject", subject); formData.append("from_name", "ar.io Documentation Feedback"); From f521a642f1be79e22d37cf52aa166341d229f2ca Mon Sep 17 00:00:00 2001 From: JonnieSparkles Date: Wed, 28 Jan 2026 11:14:04 -0500 Subject: [PATCH 09/16] Ar.io Network -> ar.io --- content/build/access/arns.mdx | 2 +- content/build/access/wayfinder.mdx | 4 +- content/build/guides/depin.mdx | 4 +- .../deploying-with-arlink.mdx | 6 +- .../deploying-with-permaweb-deploy.mdx | 2 +- .../hosting-with-ardrive.mdx | 2 +- .../hosting-decentralised-apps/index.mdx | 6 +- .../using-undernames-for-versioning.mdx | 2 +- content/build/guides/storing-nfts.mdx | 18 ++-- content/build/index.mdx | 8 +- content/build/run-a-gateway/index.mdx | 4 +- .../build/run-a-gateway/join-the-network.mdx | 4 +- .../manage/content-moderation.mdx | 2 +- .../manage/environment-variables.mdx | 2 +- .../run-a-gateway/manage/troubleshooting.mdx | 2 +- content/build/run-a-gateway/quick-start.mdx | 2 +- content/glossary.mdx | 2 +- content/learn/(introduction)/what-is-ario.mdx | 16 ++-- .../learn/(introduction)/what-is-arweave.mdx | 6 +- content/learn/arns/pricing-model.mdx | 2 +- content/learn/gateways/data-retrieval.mdx | 6 +- content/learn/gateways/gateway-registry.mdx | 12 +-- content/learn/oip/index.mdx | 2 +- content/learn/token/add-to-wander.mdx | 2 +- content/learn/token/architecture.mdx | 2 +- content/learn/token/get-the-token.mdx | 4 +- content/learn/token/index.mdx | 6 +- content/learn/token/staking.mdx | 12 +-- content/sdks/ar-io-sdk/index.mdx | 4 +- content/sdks/index.mdx | 6 +- .../(apis)/turboauthenticatedclient.mdx | 2 +- content/sdks/wayfinder/index.mdx | 4 +- .../wayfinder-core/gateway-providers.mdx | 2 +- public/llms-full.txt | 94 +++++++++---------- public/sdks/turbo-sdk/llm.txt | 2 +- 35 files changed, 128 insertions(+), 128 deletions(-) diff --git a/content/build/access/arns.mdx b/content/build/access/arns.mdx index 5bfa34c10..e1fb79634 100644 --- a/content/build/access/arns.mdx +++ b/content/build/access/arns.mdx @@ -104,7 +104,7 @@ ArNS provides significant advantages for accessing data on Arweave: } > Learn how to participate in the ar.io ecosystem. diff --git a/content/build/access/wayfinder.mdx b/content/build/access/wayfinder.mdx index a1086b6bc..b3b8afaaf 100644 --- a/content/build/access/wayfinder.mdx +++ b/content/build/access/wayfinder.mdx @@ -5,7 +5,7 @@ description: "Use Ar.io Wayfinder for decentralized content discovery and optimi import { Code, Globe, Search, Link } from "lucide-react"; -Wayfinder is a client-side routing and verification protocol that provides **decentralized, cryptographically verified access** to data stored on Arweave via the Ar.io Network. +Wayfinder is a client-side routing and verification protocol that provides **decentralized, cryptographically verified access** to data stored on Arweave via ar.io. ## What is Wayfinder? @@ -103,7 +103,7 @@ function YourComponent() { ## Why Use Wayfinder? -Wayfinder eliminates centralized points of failure by distributing data access across the decentralized Ar.io Network, reducing dependency on arweave.net and providing advanced capabilities for production applications: +Wayfinder eliminates centralized points of failure by distributing data access across the decentralized ar.io Network, reducing dependency on arweave.net and providing advanced capabilities for production applications: **Maximum Reliability** diff --git a/content/build/guides/depin.mdx b/content/build/guides/depin.mdx index 353401e10..a4cc86264 100644 --- a/content/build/guides/depin.mdx +++ b/content/build/guides/depin.mdx @@ -1,13 +1,13 @@ --- title: "Storing DePIN Data on Arweave Using Turbo" -description: "Complete guide to storing and accessing DePIN network data permanently on Arweave using Turbo and Ar.io Network" +description: "Complete guide to storing and accessing DePIN network data permanently on Arweave using Turbo and ar.io Network" --- import { Database, Globe, Search, Upload, Tag, Code, Book } from "lucide-react"; DePIN networks require **scalable and cost-effective storage solutions** they can trust. With vast amounts of data generated by decentralized physical infrastructure networks, traditional on-chain storage is prohibitively expensive, yet networks need reliable, long-term access to their device data. -Arweave via Ar.io Network provides **chain-agnostic, permanent and immutable storage** for a one-time fee, ensuring networks can access any device data previously stored and verify it has not been tampered with. +Arweave via ar.io Network provides **chain-agnostic, permanent and immutable storage** for a one-time fee, ensuring networks can access any device data previously stored and verify it has not been tampered with. ## Getting Started with DePIN Data Storage diff --git a/content/build/guides/hosting-decentralised-apps/deploying-with-arlink.mdx b/content/build/guides/hosting-decentralised-apps/deploying-with-arlink.mdx index 7e8243348..fec9a67e6 100644 --- a/content/build/guides/hosting-decentralised-apps/deploying-with-arlink.mdx +++ b/content/build/guides/hosting-decentralised-apps/deploying-with-arlink.mdx @@ -11,14 +11,14 @@ import { Zap, Github, Globe, Sparkles, FileCode, Rocket, GitBranch } from 'lucid ![Arlink login page showing GitHub, Wander, and MetaMask authentication options](/arlink-homepage.png) ## Introduction -In the previous guides in this series, we've used a CLI tool called `permaweb-deploy` to configure and host decentralised apps on Ar.io Network. +In the previous guides in this series, we've used a CLI tool called `permaweb-deploy` to configure and host decentralised apps on ar.io Network. -In this guide we'll be using [Arlink](https://arlink.ar.io), a visual, web-based platform for hosting decentralised apps on Ar.io Network without needing command-line tools. +In this guide we'll be using [Arlink](https://arlink.ar.io), a visual, web-based platform for hosting decentralised apps on ar.io Network without needing command-line tools. It offers automated builds, GitHub integration, and seamless ArNS management through an intuitive interface. -Check out the [series introduction](/build/guides/hosting-decentralised-apps) to learn how Ar.io Network enables permanent, decentralised hosting with 100+ independent gateways. +Check out the [series introduction](/build/guides/hosting-decentralised-apps) to learn how ar.io Network enables permanent, decentralised hosting with 100+ independent gateways. ## What You'll Learn diff --git a/content/build/guides/hosting-decentralised-apps/deploying-with-permaweb-deploy.mdx b/content/build/guides/hosting-decentralised-apps/deploying-with-permaweb-deploy.mdx index 697d8b272..4c1ef27b8 100644 --- a/content/build/guides/hosting-decentralised-apps/deploying-with-permaweb-deploy.mdx +++ b/content/build/guides/hosting-decentralised-apps/deploying-with-permaweb-deploy.mdx @@ -16,7 +16,7 @@ import { BookOpen, } from 'lucide-react'; -Permaweb-deploy is the recommended CLI tool for hosting decentralised applications on Ar.io Network. +Permaweb-deploy is the recommended CLI tool for hosting decentralised applications on ar.io Network. It streamlines the entire deployment process by uploading your build folder to Arweave, creating Arweave manifests, and automatically updating your ArNS records in a single command. diff --git a/content/build/guides/hosting-decentralised-apps/hosting-with-ardrive.mdx b/content/build/guides/hosting-decentralised-apps/hosting-with-ardrive.mdx index 6593e9d11..0919da8c0 100644 --- a/content/build/guides/hosting-decentralised-apps/hosting-with-ardrive.mdx +++ b/content/build/guides/hosting-decentralised-apps/hosting-with-ardrive.mdx @@ -13,7 +13,7 @@ import { Upload, Globe, Code } from 'lucide-react'; Create **permanent dApps** using the ArDrive web interface. This guide shows you how to deploy your dApp or website to the permaweb using ArDrive's user-friendly interface. -Check out the [series introduction](/build/guides/hosting-decentralised-apps) to learn how Ar.io Network enables permanent, decentralised hosting with 100+ independent gateways. +Check out the [series introduction](/build/guides/hosting-decentralised-apps) to learn how ar.io Network enables permanent, decentralised hosting with 100+ independent gateways. ## What You'll Learn diff --git a/content/build/guides/hosting-decentralised-apps/index.mdx b/content/build/guides/hosting-decentralised-apps/index.mdx index 1708552c1..9c7f49809 100644 --- a/content/build/guides/hosting-decentralised-apps/index.mdx +++ b/content/build/guides/hosting-decentralised-apps/index.mdx @@ -1,5 +1,5 @@ --- -title: "Hosting Decentralised Apps on Ar.io Network" +title: "Hosting Decentralised Apps on ar.io Network" description: "Learn how to deploy permanent, censorship-resistant websites and applications to Arweave with ArNS domain integration" --- @@ -15,7 +15,7 @@ import { The goal of decentralised apps (dapps) has always been full stack. However, until now, that has not been possible due to single points of failure for hosting frontends. -Ar.io Network solves this via: +Ar.io solves this via: - **Permanent Storage**: Pay once and store your site forever on [Arweave](https://arweave.org/). - **Smart Domains**: a sovereign owned domain-space via [Arweave Name System (ArNS)](/learn/arns). @@ -32,7 +32,7 @@ You can repeat this by loading the `docs` subdomain for any of the ~600 active g ## What You'll Learn -In this guide series, you'll learn how to deploy and manage permanent applications on Ar.io Network. +In this guide series, you'll learn how to deploy and manage permanent applications on ar.io Network. We'll cover the following: diff --git a/content/build/guides/hosting-decentralised-apps/using-undernames-for-versioning.mdx b/content/build/guides/hosting-decentralised-apps/using-undernames-for-versioning.mdx index 5c1592d21..d73d96a1f 100644 --- a/content/build/guides/hosting-decentralised-apps/using-undernames-for-versioning.mdx +++ b/content/build/guides/hosting-decentralised-apps/using-undernames-for-versioning.mdx @@ -401,5 +401,5 @@ You now know how to manage multiple environments using ArNS undernames: - **GitHub Actions automation** for branch-based deployments - **Instant rollbacks** through the ArNS app interface -In our next guides we're explore other tools you can use to host websites on Ar.io Network without needing to configure `permaweb-deploy`. +In our next guides we're explore other tools you can use to host websites on ar.io Network without needing to configure `permaweb-deploy`. diff --git a/content/build/guides/storing-nfts.mdx b/content/build/guides/storing-nfts.mdx index cd702f626..c4c8eeba7 100644 --- a/content/build/guides/storing-nfts.mdx +++ b/content/build/guides/storing-nfts.mdx @@ -1,5 +1,5 @@ --- -title: "Storing NFTs on Ar.io Network" +title: "Storing NFTs on ar.io Network" description: "Learn how to store NFT assets permanently on Arweave with guaranteed access forever using Turbo and ar:// protocol" --- @@ -8,7 +8,7 @@ import { Steps, Step } from "fumadocs-ui/components/steps"; import { Card, Cards } from "fumadocs-ui/components/card"; import { Shield, DollarSign, Globe, Image } from "lucide-react"; -Storing NFT assets on Ar.io Network ensures they're permanent, immutable and accessible, forever. +Storing NFT assets on ar.io Network ensures they're permanent, immutable and accessible, forever. We achieve this by providing: @@ -17,18 +17,18 @@ We achieve this by providing: - **Decentralised Gateways**: a network of 100s of incentivized gateways provide access. - **Routing Protocol**: ar://wayfinder ensures an active gateway is selected for all requests. -Once your NFT assets are stored on Ar.io Network, no one can delete, edit or "rug" them. +Once your NFT assets are stored on ar.io Network, no one can delete, edit or "rug" them. That means Creators can be confident their art will live on forever and Collectors can be confident their investment won't disappear. -## How to Store NFT assets on Ar.io Network +## How to Store NFT assets on ar.io Network -First, it's important to understand Ar.io Network doesn't let you mint NFTs. What it does provide is permanent storage and access for the media files (images, video, animations) and metadata (artist, attributes, traits) JSON which is used in NFTs. +First, it's important to understand ar.io Network doesn't let you mint NFTs. What it does provide is permanent storage and access for the media files (images, video, animations) and metadata (artist, attributes, traits) JSON which is used in NFTs. -To mint an NFT you'd typically store your assets and metadata via Ar.io Network and then use another service to "mint" the NFTs onchain. +To mint an NFT you'd typically store your assets and metadata via ar.io Network and then use another service to "mint" the NFTs onchain. -This guide is targeted at developers. If you're not a developer we strongly recommend uploading to Ar.io Network via [ArDrive](https://ardrive.io), check out this amazing video guide from [Hashlips](https://x.com/Hashlipsnft): +This guide is targeted at developers. If you're not a developer we strongly recommend uploading to ar.io Network via [ArDrive](https://ardrive.io), check out this amazing video guide from [Hashlips](https://x.com/Hashlipsnft):