Skip to content

docs: fix outdated facts found in a docs audit - #804

Merged
Gunit2481 merged 1 commit into
mainfrom
docs/audit-factual-fixes
Oct 30, 2026
Merged

Gunit2481 merged 1 commit into
mainfrom
docs/audit-factual-fixes

Conversation

@Gunit2481

Copy link
Copy Markdown
Contributor

Description

Factual corrections across 28 pages, from a docs audit. Each finding was re-verified against its primary source (runtime code, GitHub, npm, live endpoints) before being applied. Findings that did not hold up were dropped (see the end of this description).

Testnet and network facts

  • Shibuya runs on the Paseo relay chain, not Rococo or a "Tokio" relay (zombienet-testing.md, astar_family.md, hrmp.md).
  • Removed the "Rococo Astar" block from multilocation.md: it reused Astar mainnet's parachain ID (2006) and described no live network.
  • astar-safe.md: zKatana removed from the supported networks (Astar zkEVM and its testnet were sunset in March 2025).
  • tools.md: Statemint renamed to Polkadot Asset Hub.
  • interact_with_xc20.md: the Shibuya walkthrough now asks for SBY, not ASTR.

Runtime-backed corrections

  • collator/requirements.md: the kick threshold is 2 sessions (2 hours), matching KickThreshold = 2 * HOURS with SessionPeriod = HOURS in the Astar and Shiden runtimes. learn.md already said this; the two pages now agree.
  • Proxies.md, proxy-wallet.md: anonymous/killAnonymous renamed to createPure/killPure (event PureCreated); proxy type DappStaking (was DappsStaking/dAppStaking); added the StakerRewardClaim and Governance proxy types present in the runtime's ProxyType enum.
  • hacking/general.md: the exercise asked for a blocksPerEra constant on the legacy dappsStaking pallet; it now points to the dappStakingApi.blocksPerEra runtime call.
  • precompiles/xcm/xcm.md: transfer_multi_currencies showed a duplicated transfer_multiasset_with_fee signature; replaced with the real one from XCM_v2.sol.
  • precompiles/staking.md: the precompile lives in precompiles/dapp-staking, not dapps-staking-v3 (404).

Links to archived or moved resources

  • interact_with_xc20.md: ERC20.sol links moved from the archived astar-frame repo to AstarNetwork/Astar.
  • explorers.md: Blockscout now uses astar.blockscout.com / shibuya.blockscout.com. The Shiden Blockscout link is removed (no instance exists). The Shiden Polkadot.js link now uses rpc.shiden.astar.network, since the OnFinality Shiden public endpoint no longer answers.
  • governance/index.md: the "Gov v1" link now points to the Polkadot wiki's Governance v1 vs OpenGov section; the old URL redirects to the OpenGov page.
  • xc20-smart-contracts.md, create-xc20-assets.md: the checksum tool (web3-tools.netlify.app, 404) is replaced with ethers.getAddress().
  • ledger/index.md: links to the latest Zondax release instead of pinning 100.0.8.

Tokenomics and governance

  • astar-tokens.md: drops the pre-3.0 "~665,000,000 yearly" estimate and summarises Tokenomics 3.0 using the figures from the Tokenomics 3.0 page.
  • dapp-staking/index.md, protocol-parameters.md: stale "Tokenomics 2.0" labels reworded. The links are unchanged, because that page carries the current per-network parameter table.
  • subsquare_guide.md: the threshold example uses the 6-member Community Council (4 of 6), consistent with the same page.
  • extrinsic-calls.md: "five core areas" corrected to four.
  • dapp-staking-protocol.md: the registration line now describes the forum application plus onchain approval flow and links to the registration guide.
  • register-dapp.md: removed the "Subscan (for Astar Native)" verification line, since Wasm contracts are gone after Runtime 2500.

Small fixes

  • web3-onboard.md: locahost typo fixed; ethers.providers.Web3Provider replaced by ethers.BrowserProvider, since the page installs unpinned ethers (v6).
  • building_node.md: removed a stray zeafr line.
  • chainide/use.md: dropped the "V16" pin from the third-party sandbox description.

Audit findings not applied, after verification

  • Tokenomics 3.0 "Staking cycle: 3 periods per year to 1": correct as written; the runtime has periods_per_cycle = 1.
  • Lockdrop access deadline (31 Aug 2024) and Enkrypt's buy-flow token list: need confirmation from the team or vendor, left as is.

Type of Change

  • Bug fix (typo, broken link, outdated information)
  • New integration or tooling documentation
  • New tutorial or guide
  • Structural or navigation improvement
  • Other

Linked Issue

N/A (bug fixes only)

Checklist

  • I have read the CONTRIBUTING.md guidelines
  • The build passes locally (yarn build)
  • All links in changed files are working (every link added or changed here returns 200; remaining dead links elsewhere are handled in a separate PR)
  • Images use the <Figure> component with absolute paths (no images changed)
  • Content is factual and contains no marketing language
  • The file structure follows the existing documentation hierarchy

Note: yarn build reports HTML-minifier diagnostics on 4 pages (explorers, collator/requirements, launch_services, secure_connection). They also appear on a branch from main that doesn't touch these pages, so they are pre-existing.

Factual corrections across 28 pages, each re-verified against its
primary source (runtime code, GitHub, npm, live endpoints) rather than
taken from the audit as-is.

- Testnet relay: Shibuya runs on Paseo, not Rococo or a "Tokio" relay
  (zombienet-testing, astar_family, hrmp). Drop the "Rococo Astar"
  multilocation block, which reused Astar mainnet's parachain ID 2006.
- Collator kick: requirements page now says 2 sessions (2 hours),
  matching KickThreshold = 2 * HOURS in the Astar and Shiden runtimes.
- Proxy pallet: anonymous/killAnonymous renamed to createPure/killPure;
  proxy type is DappStaking, plus the StakerRewardClaim and Governance
  types present in the runtime.
- Explorers: Blockscout moved to astar./shibuya.blockscout.com; remove
  the Shiden Blockscout link (no instance exists); the Shiden Polkadot.js
  link uses rpc.shiden.astar.network (OnFinality Shiden no longer answers).
- Repo paths: astar-frame (archived) ERC20.sol links point to the Astar
  repo; staking precompile lives in precompiles/dapp-staking.
- XCM precompile: transfer_multi_currencies showed a duplicated
  transfer_multiasset_with_fee signature; use the one in XCM_v2.sol.
- Tokenomics: ASTR overview no longer quotes the pre-3.0 ~665M/year
  estimate; stale "Tokenomics 2.0" labels reworded (links unchanged,
  that page carries the current per-network parameter table).
- Governance: council threshold example uses the 6-member Community
  Council (4 of 6); "five core areas" -> four; dApp registration flow
  describes forum application plus onchain approval; Gov v1 link
  points to the Polkadot wiki comparison section.
- Misc: zKatana removed from Astar Safe networks; Statemint -> Polkadot
  Asset Hub; Shibuya walkthrough asks for SBY not ASTR; localhost typo;
  ethers v6 BrowserProvider; stray "zeafr" line; dead checksum tool
  replaced with ethers.getAddress(); Ledger app pinned to latest
  release instead of 100.0.8; Native (Wasm) verification line removed
  from the dApp registration guide.
@Gunit2481 Gunit2481 added the documentation Improvements or additions to documentation label Oct 30, 2026
@Gunit2481
Gunit2481 requested a review from ipapandinas October 30, 2026 11:20
@github-actions

Copy link
Copy Markdown

Visit the preview URL for this PR (updated for commit 2860b56):

https://astar-docs--pr804-docs-audit-factual-f-k9py926b.web.app

(expires Fri, 06 Nov 2026 11:21:06 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: f2f13e9b593d211faae6343d67a88fac3fd7268d

@Gunit2481
Gunit2481 merged commit 057bb07 into main Oct 30, 2026
4 checks passed
@Gunit2481
Gunit2481 deleted the docs/audit-factual-fixes branch October 30, 2026 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants