Migration#111
Draft
JonnieSparkles wants to merge 32 commits intomainfrom
Draft
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>
- 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>
- Updated Turbo credits table to reflect new fee structure: "All others" increased from 23.4% to 35%. - Revised glossary entries to replace AO references with Solana terminology, including new definitions for Ar.io Name System (ArNS), Ar.io Name Token (ANT), and other key concepts related to the migration. - Added new entries for Cranker, Epoch Pipeline, Gateway Address Registry, and more to enhance clarity on Solana-specific features.
…ystem - Changed all instances of "Arweave Name System" to "Ar.io Name System" across multiple documentation files for consistency. - Updated titles, descriptions, and content in various guides and API references to reflect the new naming convention. - Ensured that all links and references to the naming system are correctly aligned with the updated terminology.
…documentation - Changed all instances of "Arweave Name Service" to "Ar.io Name System" in the introduction and LLM text files for consistency.
… across documentation - Changed all instances of "Arweave Name Token (ANT)" to "Ar.io Name Token (ANT)" in various guides, SDKs, and glossary entries for consistency. - Ensured that all related content accurately reflects the updated terminology to enhance clarity and coherence in the documentation.
- Changed all instances of "Turbo app" to "Console app" in various guides and text files for consistency. - Updated links and descriptions to reflect the new naming convention for the Turbo service, enhancing clarity in the documentation.
… page - Updated the "pages" array in meta.json to include the new "what-is-permaweb" page. - Corrected capitalization in the "solana-developers.mdx" file for consistency. - Added a new comprehensive page titled "What is the Permaweb?" detailing its architecture and significance in the decentralized internet.
…page - Removed the "what-is-permaweb" page to streamline content; relevant information has been integrated into "what-is-ario.mdx". - Updated the "pages" array in meta.json to reflect the changes. - Corrected capitalization in the "solana-developers.mdx" file for consistency. - Enhanced the "what-is-ario.mdx" file with additional context about the permaweb.
- Updated the redirect for '/ario-contract' to point to the new '/learn/protocol-architecture' page. - Corrected instances of "on-chain" to "onchain" across multiple documentation files for consistency. - Added a new page titled "Protocol Architecture" detailing the technical architecture of the ar.io Solana programs and protocol components. - Updated the introduction meta.json to include the new "protocol-architecture" page.
…ails - Added information about transaction fees in the Solana runtime, highlighting their role in discouraging spam and unnecessary writes. - This update improves the clarity and comprehensiveness of the technical security section in the protocol architecture documentation.
- Streamlined the security model section by consolidating economic, technical, and governance security aspects into a more cohesive format. - Enhanced clarity on the role of Solana runtime guarantees, account ownership, and economic incentives in ensuring protocol security. - Removed redundant details while emphasizing the importance of permissionless verification and economic accountability for gateway operators.
- Updated the ARIO token overview to focus on its usage and compatibility within the Solana ecosystem, enhancing the explanation of its multi-utility design and network incentives. - Reorganized sections to improve flow, including merging and renaming headings for better clarity. - Revised staking documentation to clarify the staking process, including the introduction of vaults and the concept of excess stake. - Enhanced the wallets section to specify compatibility with Solana wallets and removed outdated content for a more streamlined presentation. - Updated migration status to reflect the completion of rewrites and new content additions.
- Revised content across multiple pages to enhance clarity, including updates to terminology and structure. - Improved descriptions of Ar.io Name Tokens (ANTs) and their functionalities, emphasizing ownership and control mechanisms. - Clarified the registration process, including lease and permanent options, and streamlined the explanation of the Dutch auction for returned names. - Adjusted pricing model details to reflect a more conceptual overview, removing excessive formulas for better readability. - Ensured consistent use of terminology, such as "Ar.io Name System" and "undername," throughout the documentation.
- Revised multiple sections across the Observation and Incentive Protocol (OIP) documentation to improve clarity and readability. - Updated terminology for consistency, including the use of "onchain" instead of "on-chain." - Clarified the roles and responsibilities of observers, including the submission of compact pass/fail results. - Improved descriptions of the epoch pipeline and reward distribution processes, emphasizing the permissionless nature of the system. - Streamlined the observer selection process and the evaluation criteria for gateways to enhance understanding.
- Revised multiple sections across the gateway documentation to enhance clarity and readability. - Updated links and references to ensure accurate navigation, including changes to pruning and registry details. - Simplified descriptions of gateway responsibilities, focusing on data retrieval, indexing, and network participation. - Removed outdated content and consolidated information to improve the overall structure and flow of the documentation. - Added new content on gateway pruning mechanisms, emphasizing performance accountability and operator responsibilities.
- Revised the Wayfinder protocol description to clarify the distinction between TxIDs and ArNS names, and updated the explanation of gateway functionality. - Enhanced the integration section with refreshed examples and corrected an import typo for better usability. - Streamlined the use cases section for improved readability and emphasized the benefits of using Wayfinder for digital archiving and content accessibility. - Updated migration status to reflect the completion of these changes.
…arity - Revised ArNS examples to reflect the new domain structure, changing references from `arweave.net` to `ar.io`. - Updated deployment guides to ensure consistent usage of the new domain format across various sections. - Added a new guide for migrating applications to the latest SDKs, providing a placeholder for future content. - Enhanced clarity in the hosting decentralized apps section by refining descriptions and examples. - Adjusted technical details in the Solana migration guide to ensure accuracy and completeness.
…content - Introduced a comprehensive guide for deploying permanent dApps using a Solana wallet, detailing the upload process, ArNS name registration, and app accessibility. - Updated the redirects to include the new deployment guide and adjusted the navigation structure for better accessibility. - Removed the outdated "Crossmint NFT Minting App" guide and reorganized the content in the hosting decentralized apps section for clarity. - Revised references to ensure consistent terminology and improved descriptions across related guides.
- Added notes on the need to regenerate SDK and API reference pages from upstream sources to ensure they reflect the latest changes. - Revised the status of various SDK pages to indicate the need for technical review and updates. - Enhanced the clarity of migration status for SDKs and APIs, emphasizing the importance of maintaining up-to-date documentation. - Streamlined the remaining TODOs section to highlight critical tasks before launch, including regeneration of documentation and verification of examples.
Permaweb Preview DeployedYour preview is available at: https://docs-pr-111_docs.ar.io
|
Add two new operator guides under run-a-gateway/manage: - verification-headers: Documents trust/verification response headers (X-AR-IO-Verified, Content-Digest, etc.), ANS-104 bundle headers, client-side verification, and HTTP Message Signatures (RFC 9421) configuration with HTTPSIG_ENABLED env var. - nginx-caching: Production-tested NGINX caching config with tiered cache zones, route-specific TTLs, thundering herd protection, content moderation purge strategy, and troubleshooting guidance. Also adds HTTPSIG env vars to the environment-variables reference and updates CLAUDE.md with minor improvements. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Rewrite clickhouse.mdx from basic setup guide into comprehensive operational reference covering architecture (speed/batch layer), TTL rules, deployment topologies, auto-import tuning, circuit breaker, and troubleshooting. Fix docker-compose (v1 hyphenated) to docker compose (v2 space) in troubleshooting.mdx. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
2 participants
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.
No description provided.