docs: make JavaScript examples executable - #232
Merged
Conversation
✅ Deploy Preview for koinos-documentation ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
pgarciagon
force-pushed
the
codex/executable-javascript-examples
branch
3 times, most recently
from
July 23, 2026 20:06
e1396d7 to
d5a052c
Compare
pgarciagon
force-pushed
the
codex/executable-javascript-examples
branch
from
July 23, 2026 20:12
d5a052c to
b13a8a0
Compare
pgarciagon
marked this pull request as ready for review
July 23, 2026 20:31
This was referenced Jul 23, 2026
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.
Summary
This PR consolidates the earlier Getting Started review from #231 with the
executable JavaScript example rollout. It supersedes #231.
Koinos CLI, Koinos overview, and tooling guidance
examples/javascript/source through checked PyMdown snippets
and tested behavior
enforcement, clean-start checks, and CI
The cross-chapter example scope is intentional and user-authorized. Changes
outside Getting Started are limited to replacing or supporting JavaScript
examples.
Inventory
The machine-readable inventory is
examples/javascript/manifest.json. Itrecords page, line, purpose, runtime, dependencies, network, safety class,
project, canonical source section, and runner metadata for every active fence.
Safety decisions
Koinos Foundation public testnet
BROADCAST=trueand a locally suppliedTESTNET_WIFis embedded or requested in a hosted runner
faucet-account access are automated
user gestures and the hosted-runner limitation is explicit
Current-source validation
Implementation was checked against:
Live smoke runs confirmed the mainnet and current testnet chain IDs, current
heads, testnet health, contract metadata, the testnet KOIN contract, and
read-only REST responses.
Verification
The following passed:
Evidence:
browser tests use a mocked wallet/provider
and current-testnet reads
expected headings and controls; no snippet directive is exposed
Feature-ref StackBlitz imports resolved the correct package/project titles, but
the in-app WebContainer remained at
Mounting environment in StackBlitz.Local clean starts and live smoke runs therefore provide the execution evidence.
Permanent runner links target
master, the repository publication branch, sothey resolve after promotion rather than retaining a disposable feature ref.
Known pre-existing warnings
MkDocs still reports these unrelated warnings from
origin/dev:exchanges/jsonrpc.mddoes not existdocs/index.mdlinks to missinginteracting/koilib.mdCommit groups