Skip to content

docs: consolidate four-chapter documentation update - #238

Merged
joticajulian merged 24 commits into
devfrom
codex/update-four-chapters-docs
Aug 1, 2026
Merged

docs: consolidate four-chapter documentation update#238
joticajulian merged 24 commits into
devfrom
codex/update-four-chapters-docs

Conversation

@pgarciagon

Copy link
Copy Markdown

Purpose

This draft PR consolidates the complete documentation work assigned to pgarcgo:

  1. Getting Started
  2. Node Operators
  3. Architecture
  4. Resources

It combines the three still-open chapter branches (#235, #236, and #237) on top
of the Getting Started work already merged into dev through #232, #233, and
#234.

The exhaustive comparison against the exact pre-work baseline is:

drafts/reports/FOUR_CHAPTERS_CHANGE_REPORT.md

The report covers every public page, cross-chapter change, executable example,
internal draft, verification script, safety decision, source baseline, removal,
validation result, and integration consideration.

Important diff limitation

The original comparison point is dev commit
00a8ef863e2eefa07b540d772725a5c372f1c92d, the first parent of the #232 merge.

GitHub's Files changed view cannot show Getting Started as new because that
tree is already present in the current dev base. The report therefore
reconstructs the full four-chapter comparison:

  • pre-report result versus original baseline: 142 paths, 12,410 insertions,
    5,703 deletions;
  • this consolidated PR versus current dev: Node Operators, Architecture,
    Resources, and the report;
  • merging this PR once leaves dev with all four completed chapters.

No revert or force-reset of dev was used.

Chapter summary

Getting Started

Already merged through #232-#234 and documented here as part of the complete
review:

  • rewrote the landing page, Koinos concepts, account/key/wallet safety,
    mainnet/testnet, Kondor, Koinos CLI, and tooling pages;
  • removed the Sovrano page and tracked references;
  • replaced Harbinger-era public-testnet guidance with current reset-aware
    endpoint, chain-ID, health, and faucet procedures;
  • introduced seven self-contained JavaScript projects and a 50-example
    manifest;
  • provided canonical complete files and truthful runner/local-run paths;
  • made mainnet examples read-only and testnet state changes dry-run and
    explicitly gated;
  • corrected post-merge development links and stale REST/offline-signing
    material.

Node Operators

Consolidates #235:

  • adds a standard-node quick path and complete Ubuntu production procedure;
  • corrects connected-peer and restart-loop checks;
  • completes UFW activation/recovery and external exposure verification;
  • makes /opt/koinos-next activation and rollback use the correct Compose
    project;
  • adds direct backup/restore, update/rollback, reindex, and resync procedures;
  • preserves checksums, archive safety, chain IDs, block verification, rollback
    copies, data, and key/P2P identity separation;
  • adds 90-block/455-assertion command verification;
  • retains legacy Validators URLs as concise pointers to maintained pages.

Architecture

Consolidates #236:

  • rebuilds the chapter around one versioned official microservice topology;
  • restores the microservices overview and internal messaging in navigation;
  • fills Chain, Block Store, P2P, Mempool, Transaction Store, Block Producer,
    JSON-RPC, gRPC, REST, Contract Meta Store, and Account History pages;
  • explains state ownership, lag, forks, failure, and consistency boundaries;
  • rewrites smart contracts, ABI, system calls, serialization, Resources, and
    Proof of Burn around stable architecture rather than historical parameters;
  • separates operator procedures, privileged contracts, and contract
    development into their assigned chapters;
  • preserves the internal research foundation outside the public MkDocs tree.

Resources

Consolidates #237:

  • rebuilds Resources as a task-oriented, evidence-based directory;
  • distinguishes official, community-maintained, and third-party ownership;
  • completes wallet coverage for Kondor, Tangem, kcli, and the Koinos CLI
    cross-reference;
  • verifies Koinosblocks, KoinosScan, and Koinscan, and removes Harbinger;
  • adds neutral, sourced ecosystem entries including Koin Krew, Koinos One, and
    Teleno;
  • corrects KCS-1 through KCS-5 from the canonical standards repository;
  • removes unsupported high-level SDK claims;
  • adds Community and learning plus an internal dated inventory;
  • makes Resources discoverable from the home page without rewriting another
    assigned chapter.

Safety and editorial decisions

  • no --profile all node quick start;
  • no executable KOIN burn, producer registration, or other irreversible action;
  • no production secret in an example or hosted runner;
  • no Harbinger-as-current-testnet or Sovrano reference in the updated scope;
  • no unsupported SDK, API, network, explorer, wallet, or ecosystem claim;
  • no security, audit, return, liquidity, performance, or endorsement claim
    without evidence;
  • no historical consensus amount/parameter presented as current;
  • current technical claims use canonical and immutable sources where
    appropriate;
  • internal plans, inventories, and this report remain outside the generated
    site.

Consolidated validation

Passed on the combined tree:

  • npm ci --ignore-scripts
  • JavaScript syntax checks for verification scripts
  • npm run examples:verify — 50 documented examples / 50 manifest entries
  • npm run examples:syntax — 22 JavaScript files
  • npm run examples:test — 23 tests across seven workspaces
  • npm run examples:start — seven projects
  • npm run examples:smoke — seven projects, including live read-only mainnet
    and current-public-testnet checks
  • npm run node-commands:verify — 90 command blocks / 455 assertions
  • npm run docs:links
  • normal MkDocs build
  • generated-site audit: no drafts/ plan, inventory, foundation, or report
    content
  • git diff --check

The strict MkDocs build stops only on two warnings already present in the
original dev baseline:

  • missing exchanges/jsonrpc.md navigation target;
  • missing interacting/koilib.md target from docs/index.md.

No new strict-build warning was introduced.

Local responsive review covered:

  • Getting Started landing page;
  • Node Operators landing and Backup/restore;
  • Architecture landing and REST service page;
  • Resources landing and Explorers;
  • combined navigation links.

All seven routes were checked at 1440×900 and 390×844. No document-level
overflow, broken image, or browser console error was found.

Source PRs

This PR must remain a draft targeting dev until the consolidated review is
complete. Do not merge it automatically.

@netlify

netlify Bot commented Jul 25, 2026

Copy link
Copy Markdown

Deploy Preview for koinos-documentation ready!

Name Link
🔨 Latest commit 9178aa7
🔍 Latest deploy log https://app.netlify.com/projects/koinos-documentation/deploys/6a6c638b1edec7000839790d
😎 Deploy Preview https://deploy-preview-238--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

Consolidated validation is complete. GitHub verification and the Netlify deploy preview pass. The source PRs #235, #236, and #237 are now closed as superseded; their branches and commits remain available.\n\n- Exhaustive four-chapter change report\n- Consolidated deploy preview\n\nThis PR remains a draft targeting dev and has not been merged.

Comment thread docs/architecture/resources.md
@joticajulian
joticajulian marked this pull request as ready for review August 1, 2026 05:24
@joticajulian
joticajulian merged commit a30c7b3 into dev Aug 1, 2026
5 checks passed
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.

3 participants