docs: migrate documentation from AO to Solana#110
Open
vilenarios wants to merge 12 commits intomainfrom
Open
Conversation
Comprehensive page-by-page analysis of what needs updating in docs.ar.io for the AO→Solana migration. Covers ~97 pages across learn/, build/, sdks/, apis/, and glossary. Identifies 6 full rewrites, 8 major updates, 16 partial updates, and 7 new pages needed. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Complete documentation migration reflecting ar.io's protocol execution move from AO (Arweave compute) to Solana. The ARIO token is now an SPL Token, ANTs are Metaplex Core NFTs, and epochs are driven by a permissionless 6-step cranker pipeline. Changes across 63 files (255 pages audited): Rewritten (7): token overview, architecture, get-the-token, staking, SDK configuration, networks, general New pages (6): wallet setup, migration guide, epoch pipeline, cranker, gateway pruning, returned name auctions Deleted (2): AO compute-unit extension, add-to-wander guide Updated (48): ArNS docs (ANTs as Metaplex Core NFTs, 50K name cap, Dutch auctions), gateway registry (3K cap, observer uniqueness, pruning), OIP (Solana Programs terminology, reward accumulator, on-chain observations), SDK examples (Solana signers via @solana/kit, removed ArweaveSigner from all ar.io SDK code examples), environment variables (removed AO sections, added Solana RPC), turbo-credits (ARIO on Solana), join-the-network (Solana keypair CLI), glossary (7 new Solana terms) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The permaweb architecture diagram and Layer 2 description now show both AO and Solana as compute platforms. ar.io uses Solana for protocol execution while AO remains part of the broader permaweb ecosystem. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Permaweb Preview DeployedYour preview is available at: https://docs-pr-110_docs.ar.io
|
- Split general.mdx init examples into separate code blocks (was redeclaring const ario 3 times in one block) - Standardize signer variable name across all examples to just `signer` (was inconsistently using solanaKeypairSigner, solanaWalletAdapter) - Fix broken `const signer = signer;` in set-arns-records guide - Add comments pointing to Configuration page for signer setup - Clean up ANT.init() examples for browser vs node Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Add SDK version requirement callout (v3.23+ for Solana) to Quick
Start and Configuration pages
- Add @solana/kit install instruction to Configuration page
- Add processId field naming explanation to ArNS SDK page (retained
for backwards compatibility, refers to ANT mint address on Solana)
- Add SOL cost estimate ("< 0.01 SOL per transaction") to staking page
- Update quick-start.mdx with Solana pubkey format for AR_IO_WALLET
and OBSERVER_WALLET, add observer uniqueness note
- Add RPC endpoint guidance to environment variables page (recommend
Helius/Triton/QuickNode for production over public RPC)
- Add dedicated RPC warning to SDK Configuration page
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
New page: build/run-a-gateway/manage/solana-migration.mdx - Step-by-step guide for existing operators: address mapping, Solana keypair generation, SOL funding, .env updates, node upgrade - Documents new risks: 30-epoch pruning, SOL balance monitoring - Covers optional epoch cranking opt-in - Added to manage nav as first item (highest visibility) Also replaced all arns.app references with arns.ar.io across 14 files. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Reflects all 6 commit passes: initial migration, permaweb update, code example fixes, DX improvements, operator guide, and arns.ar.io. Updated counts: 7 rewritten, 52 updated, 7 new, 2 deleted, ~192 no change. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
New pages for Solana developers coming to ar.io:
1. learn/(introduction)/solana-developers.mdx
- Concept mapping table (SPL Token, Metaplex Core, PDA, CPI)
- What you need / don't need
- 5-minute quick start: upload → register name → set record
- ArNS URL patterns across gateways
- Costs at a glance
- Placed after "What is ar.io?" in Introduction nav
2. build/guides/deploy-permanent-dapp.mdx
- End-to-end: build app → upload with Turbo (SOL) → register
ArNS name → set ANT record → verify
- Dual signer setup (@solana/kit for SDK, Turbo Solana signer)
- Update and rollback patterns using undernames
- Complete copy-paste deployment script
- Placed first in Guides nav for maximum visibility
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Comprehensive reference file for AI agents (Claude, Cursor, Copilot) to build applications on ar.io and Arweave. Covers: - SDK init patterns (ar.io SDK + Turbo + Wayfinder) - Dual signer setup (@solana/kit vs Turbo's own format) - Common recipes: upload, deploy, ArNS names, records, resolution - ArNS URL patterns and underscore convention - Gateway API endpoints - All key constants (pricing, limits, durations) - Critical code generation rules - Full API method reference (read, write, ANT, Turbo) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Copy SKILL.md to public/ so it's served at docs.ar.io/SKILL.md - Add public/llms.txt as discovery entrypoint (llmstxt.org convention) pointing to SKILL.md, llms-full.txt, and key doc sections - Agents can now: fetch /llms.txt → find /SKILL.md → generate code Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
….md) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Run generate-llm-text.js and generate-sdk-llm-texts.js to rebuild public/llms-full.txt and per-SDK llm.txt files from current content. Removes stale AO references from generated files (deleted compute-unit page, old "AO Computer based" descriptions, etc). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2ca0fe7 to
1c677a8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Complete documentation migration reflecting ar.io's protocol execution move from AO (Arweave compute) to Solana. Covers 255 pages audited across the entire docs portal.
@solana/kit), environment variables (removed AO sections, added Solana RPC), turbo-credits (ARIO on Solana), join-the-network (Solana keypair CLI), glossary (7 new Solana terms), permaweb (Solana added to architecture diagram)Key architecture changes reflected:
Remaining TODOs (pre-launch):
<ARIO_MINT_ADDRESS>and<ARIO_PROGRAM_ID>placeholders with final addressesnpm run generate-all-docsto regenerate LLM text filesSource material:
solana-ar-io/docs/BEHAVIORAL_DIFFERENCES.md(95 behavioral differences)solana-ar-io/docs/MECHANISM_MAPPING.md(26 AO→Solana mappings)solana-ar-io/docs/EPOCH_CRANKER_ARCHITECTURE.mdsolana-ar-io/docs/MIGRATION_ARCHITECTURE.mdsolana-ar-io/sdk/README.mdTest plan
yarn installsucceedsset NODE_ENV=production && npx next build) — 259/259 pages generated{/* */}syntax)npm run check-links— run post-merge🤖 Generated with Claude Code