docs: consolidate four-chapter documentation update - #238
Merged
Conversation
…' into codex/update-four-chapters-docs
…into codex/update-four-chapters-docs
…o codex/update-four-chapters-docs
✅ Deploy Preview for koinos-documentation ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This was referenced Jul 25, 2026
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. |
joticajulian
marked this pull request as ready for review
August 1, 2026 05:24
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.
Purpose
This draft PR consolidates the complete documentation work assigned to pgarcgo:
It combines the three still-open chapter branches (#235, #236, and #237) on top
of the Getting Started work already merged into
devthrough #232, #233, and#234.
The exhaustive comparison against the exact pre-work baseline is:
drafts/reports/FOUR_CHAPTERS_CHANGE_REPORT.mdThe 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
devcommit00a8ef863e2eefa07b540d772725a5c372f1c92d, 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
devbase. The report thereforereconstructs the full four-chapter comparison:
5,703 deletions;
dev: Node Operators, Architecture,Resources, and the report;
devwith all four completed chapters.No revert or force-reset of
devwas used.Chapter summary
Getting Started
Already merged through #232-#234 and documented here as part of the complete
review:
mainnet/testnet, Kondor, Koinos CLI, and tooling pages;
endpoint, chain-ID, health, and faucet procedures;
manifest;
explicitly gated;
material.
Node Operators
Consolidates #235:
/opt/koinos-nextactivation and rollback use the correct Composeproject;
copies, data, and key/P2P identity separation;
Architecture
Consolidates #236:
JSON-RPC, gRPC, REST, Contract Meta Store, and Account History pages;
Proof of Burn around stable architecture rather than historical parameters;
development into their assigned chapters;
Resources
Consolidates #237:
cross-reference;
Teleno;
assigned chapter.
Safety and editorial decisions
--profile allnode quick start;without evidence;
appropriate;
site.
Consolidated validation
Passed on the combined tree:
npm ci --ignore-scriptsnpm run examples:verify— 50 documented examples / 50 manifest entriesnpm run examples:syntax— 22 JavaScript filesnpm run examples:test— 23 tests across seven workspacesnpm run examples:start— seven projectsnpm run examples:smoke— seven projects, including live read-only mainnetand current-public-testnet checks
npm run node-commands:verify— 90 command blocks / 455 assertionsnpm run docs:linksdrafts/plan, inventory, foundation, or reportcontent
git diff --checkThe strict MkDocs build stops only on two warnings already present in the
original
devbaseline:exchanges/jsonrpc.mdnavigation target;interacting/koilib.mdtarget fromdocs/index.md.No new strict-build warning was introduced.
Local responsive review covered:
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
devuntil the consolidated review iscomplete. Do not merge it automatically.