Skip to content

Update Resources documentation - #237

Closed
pgarciagon wants to merge 4 commits into
devfrom
codex/update-resources-docs
Closed

Update Resources documentation#237
pgarciagon wants to merge 4 commits into
devfrom
codex/update-resources-docs

Conversation

@pgarciagon

@pgarciagon pgarciagon commented Jul 25, 2026

Copy link
Copy Markdown

Summary

  • add the tracked internal Resources plan and a dated candidate inventory outside the published MkDocs tree
  • rebuild Resources as a task-oriented directory with visible official, community-maintained, and third-party classifications
  • complete wallets, explorers/network tools, ecosystem applications/services, contract standards, and SDK/library/tool pages
  • add Community and learning guidance and restore normal nested Resources navigation
  • add a narrow Resources card to the home page without rewriting other chapters
  • follow up on koinos/koinos-io-website#142 by independently verifying and documenting Koinscan, Koin Krew, Koinos One, and Teleno
  • add pgarciagon/kcli as a community-maintained command-line wallet with prominent source, dependency, secret-handling, and network-selection limitations
  • add KoinosScan as a community-maintained mainnet explorer and analytics platform, with verified functions, source, API scope, and LIB-based synchronization behavior

Inventory decisions and verified sources

Public entries are limited to resources with a current canonical source and a purpose that could be verified on 2026-07-25:

  • wallets: Kondor, Tangem, and the community-maintained kcli; Koinos CLI is a developer-tool cross-reference
  • explorer/network sources: Koinosblocks, KoinosScan, and Koinscan for mainnet, plus koinos/koinos-testnet as the current public-testnet authority
  • ecosystem applications/services: KoinDX, Vortex Bridge, Koin Krew, Fogata, BurnKoin, Koinos One, and Teleno
  • developer tools: Koilib, the AssemblyScript SDK and CLI, C++ SDK, Koinos CLI, local testnet, Mock VM, and protocol definitions
  • standards: KCS-1 through KCS-5, checked at immutable commit ef6f3d8edc75673842e927edba1232fe47df51e4, with current-source links alongside the reviewed links

Package versions were checked against npm and linked to immutable repository commits where applicable. Version-dependent official tools link releases/tags or reviewed commits plus their canonical repositories.

The internal inventory records category, maintainer, ownership, canonical URL, repository evidence, supported network, verification date, decision, and limitations for included and excluded candidates.

kcli verification

pgarciagon/kcli was reviewed at source version 1.4.0, commit c263df637eb632e275e77f807777aa64c3fd54ed:

  • a clean npm ci and TypeScript build passed
  • --help and --changes matched the documented command surface
  • read-only mainnet and current-public-testnet connections were executed; the testnet constants match koinos/koinos-testnet commit 0c37959074d1d66bfafb90f44d5a6c5c5c1c5a50
  • no release or package-registry distribution was found; installation is from source
  • some commands accept a WIF or seed phrase as a process argument, and wallet generation prints the WIF
  • npm audit --omit=dev reported 20 production-dependency advisories: 14 low, 4 moderate, 1 high, and 1 critical
  • with a saved mainnet RPC, --network testnet chain-info queried mainnet while displaying a testnet label; an explicit current testnet RPC worked. The public page therefore requires independent RPC and chain-ID verification and does not rely on the network label.

No state-changing kcli command was executed during verification.

Website ecosystem discovery

Website PR koinos/koinos-io-website#142 was treated only as a discovery source:

  • Koinscan's corrected .com site was live, labeled early beta, and displayed a mainnet head within three blocks of the official API during review; no public source repository, testnet support, or documented public API was inferred
  • Koin Krew's live site and application portal verified token-tracking, NFT, airdrop, and ownership-verification tools; the directory does not assess its tokens, prices, contracts, or wallet-connected operations
  • Koinos One v1.1.1 and Teleno teleno-node-v1.1.0 were verified from their current repositories/releases and are explicitly framed as community-led experimental alternatives; the microservice-based Koinos node remains the official reference implementation
  • Kollection's GitHub organization/source remains available, but no consistently reachable live application was verified, so it remains excluded from the public live-application directory

KoinosScan verification

KoinosScan was reviewed as a community-maintained project led by interfecto:

  • the live site provides address and transaction-hash search; recent block, transaction, and block-producer views; KOIN and VHP balances, holder rankings, transfer history, and distribution charts; and historical KOIN ERC-20 claim analytics
  • the open-source koinos/koinos-token-tracker indexer was reviewed at commit c625f58aba806eb821036cd27fcea26ebbedfd7d
  • the public Token Tracker API documentation covers indexed addresses, holders, transfers, blocks, tokens, and indexer status; it is explicitly documented as an indexer API rather than a general-purpose Koinos node API
  • the live indexer was 55 blocks behind the official chain head during review, consistent with its documented policy of indexing through the last irreversible block, normally about 60 blocks behind head
  • mainnet support was verified; current-public-testnet support was not verified
  • market information and claim analytics can depend on external data or project heuristics and are presented with that limitation

Exclusions and limitations

Excluded or removed entries include:

  • wallet sites with parked/unsafe destinations or insufficient current primary evidence
  • explorer and platform candidates that failed DNS resolution, redirected to an expired-domain service, lacked evidence of current network coverage, or were not yet live
  • Arkinos and supposed Python, Go, or Rust high-level SDKs without current canonical supported implementations
  • obsolete Harbinger links and all Sovrano references from the public Resources pages
  • API claims where no current maintained API documentation was verified

The public pages make no security, audit, liquidity, reward, return, performance, reliability, or endorsement claims. Third-party bridge, wallet, signing, recovery-material, wallet-connected-application, command-line-secret, dependency, and network-selection cautions are included.

Cross-chapter changes

The only cross-chapter file changed is docs/index.md: the combined References/Resources card is split into a References card and a Resources card. Resources pages link to Getting Started, Interacting, Contracts, Node Operators, Architecture, and References; those chapters were not modified.

Validation

  • npm run docs:links — passed; the checker reports its two documented pre-existing exceptions
  • docs-venv/bin/mkdocs build — passed
  • docs-venv/bin/mkdocs build --strict — reaches only two warnings already present in origin/dev: missing exchanges/jsonrpc.md in nav and missing interacting/koilib.md from docs/index.md
  • git diff --check — passed
  • generated-site audit — passed; no drafts/resources content appears under site/
  • forbidden-name and feature-branch-link audits — passed for public Resources pages
  • initial external URL audit — 57 URLs checked with bounded timeouts; 52 returned 2xx. Four npm pages and Medium rejected the automated request with 403 and were verified through npm registry metadata/current page inspection. Redirect destinations were inspected.
  • website-PR follow-up URL audit — all nine newly referenced canonical/release URLs returned 200 after redirects
  • kcli follow-up URL audit — repository, immutable commit, advisory, and current testnet-repository URLs returned 200
  • KoinosScan follow-up URL audit — live site, API documentation, maintainer profile, source repository, and immutable reviewed commit all returned 200
  • local browser review — all changed public Resources pages plus the home page reviewed at desktop and mobile widths; no page-level overflow, broken images, or browser console errors were found. Wallet and KCS content was changed from wide tables to responsive stacked content after mobile review.
  • ecosystem follow-up local/browser review — the changed Resources hub, explorers, ecosystem page, Koinscan section, and node-software section were checked at 1280×720 and 390×844; no content overflow or browser console errors were found
  • kcli local browser review — wallet page, kcli entry, and complete warning checked at 1280×720 and 390×844; no overflow or browser console errors were found
  • KoinosScan local browser review — explorer entry, function list, ownership/source/network/API/synchronization details, and limitations checked at 1280×720 and 390×844; no overflow or browser console errors were found
  • deploy-preview browser review — repeated for all eight original routes at 1440×1000 and 390×844; no page-level overflow, broken images, overflowing code blocks, or browser console errors were found
  • ecosystem follow-up deploy-preview review — explorers, ecosystem, Koinscan, and node-software content rechecked after commit 20b53b8; no overflow or browser console errors were found
  • kcli follow-up deploy-preview review — wallet/kcli content rechecked at 1280×720 and 390×844 after commit 21a73e1; no overflow or browser console errors were found
  • KoinosScan follow-up deploy-preview review — the explorer entry was checked at 1280×720 and 390×844 after commit 4fd37da; no content overflow or browser console errors were found
  • remote checks — GitHub verify passed; Netlify deploy preview and redirect checks passed (header/pages checks were skipped by Netlify as not applicable)

No JavaScript documentation example changed, so example syntax/runtime checks were not applicable.

Review limits

Availability and third-party project status can change after the verification date. The inventory preserves rejected candidates and reasons so a future update can re-evaluate them from fresh canonical evidence.

@netlify

netlify Bot commented Jul 25, 2026

Copy link
Copy Markdown

Deploy Preview for koinos-documentation ready!

Name Link
🔨 Latest commit 4fd37da
🔍 Latest deploy log https://app.netlify.com/projects/koinos-documentation/deploys/6a64e78714c92900087a2034
😎 Deploy Preview https://deploy-preview-237--koinos-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@pgarciagon

Copy link
Copy Markdown
Author

Superseded by draft PR #238, which consolidates Node Operators, Architecture, Resources, and the complete four-chapter baseline report for a single review and merge into dev. The original branch and commits remain available; no content was discarded.

@pgarciagon pgarciagon closed this Jul 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants