Skip to content

Fix installation walkthrough cast links#4867

Open
zxzok wants to merge 1 commit into
Scottcjn:mainfrom
zxzok:fix-installation-walkthrough-cast-links
Open

Fix installation walkthrough cast links#4867
zxzok wants to merge 1 commit into
Scottcjn:mainfrom
zxzok:fix-installation-walkthrough-cast-links

Conversation

@zxzok
Copy link
Copy Markdown

@zxzok zxzok commented May 12, 2026

Summary

  • Replace asciinema .cast image embeds with normal Markdown links in the installation walkthrough.
  • Avoid broken GitHub image rendering for terminal recordings while keeping the existing local cast files linked.

Verification

  • Confirmed docs/asciinema/miner_install.cast exists.
  • Confirmed docs/asciinema/first_attestation.cast exists.

@github-actions
Copy link
Copy Markdown
Contributor

Welcome to RustChain! Thanks for your first pull request.

Before we review, please make sure:

  • Your PR has a BCOS-L1 or BCOS-L2 label
  • New code files include an SPDX license header
  • You've tested your changes against the live node

Bounty tiers: Micro (1-10 RTC) | Standard (20-50) | Major (75-100) | Critical (100-150)

A maintainer will review your PR soon. Thanks for contributing!

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/XS PR: 1-10 lines labels May 12, 2026
Copy link
Copy Markdown

@saim256 saim256 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved current head 7c5930e.

This is a scoped documentation/rendering fix: the installation walkthrough no longer uses Markdown image syntax for asciinema .cast files, which GitHub cannot render as images, and instead links directly to the two committed terminal recordings. The relative links resolve correctly from docs/INSTALLATION_WALKTHROUGH.md to docs/asciinema/miner_install.cast and docs/asciinema/first_attestation.cast, preserving access to the existing recordings without introducing binary assets or external hosting.

Validation performed locally:

  • git diff --check origin/main...HEAD -- docs/INSTALLATION_WALKTHROUGH.md -> passed
  • Test-Path docs\asciinema\miner_install.cast and Test-Path docs\asciinema\first_attestation.cast -> both true
  • line-by-line JSON validation of both asciinema v2 cast files -> miner_install.cast: 46 JSON lines ok; first_attestation.cast: 76 JSON lines ok
  • python tools\bcos_spdx_check.py --base-ref origin/main -> BCOS SPDX check: OK
  • reviewed the diff; only the two cast embeds changed from image syntax to normal Markdown links

No blocking issues found.

Copy link
Copy Markdown
Contributor

@godd-ctrl godd-ctrl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved current head 7c5930e.

This is a scoped docs-only fix: the installation walkthrough now links to the local asciinema .cast recordings as normal Markdown links instead of image embeds, avoiding broken GitHub image rendering while preserving access to the recordings.

Validation performed:

  • git diff --name-status origin/main...HEAD -> docs/INSTALLATION_WALKTHROUGH.md
  • git diff --check origin/main...HEAD -> passed
  • confirmed docs/asciinema/miner_install.cast exists
  • confirmed docs/asciinema/first_attestation.cast exists
  • rg confirmed the walkthrough contains normal .cast links and no .cast image embeds
  • python tools\bcos_spdx_check.py --base-ref origin/main -> passed

No blocking issues found in the reviewed diff.

@zxzok zxzok force-pushed the fix-installation-walkthrough-cast-links branch from 7c5930e to d70a44c Compare May 12, 2026 20:11
Copy link
Copy Markdown

@saim256 saim256 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved current head d70a44c.

This follow-up keeps the original fix intact and also corrects the sample README link to point at docs/INSTALLATION_WALKTHROUGH.md from repository-root context. The walkthrough now uses normal Markdown links for the committed asciinema recordings rather than image embeds, so GitHub will not try to render .cast files as images.

Validation performed locally:

  • git diff --check origin/main...HEAD -- docs/INSTALLATION_WALKTHROUGH.md -> passed
  • Test-Path docs\asciinema\miner_install.cast and docs\asciinema\first_attestation.cast -> both true
  • line-by-line JSON validation of both asciinema v2 cast files -> miner_install.cast: 46 JSON lines ok; first_attestation.cast: 76 JSON lines ok
  • python tools\bcos_spdx_check.py --base-ref origin/main -> BCOS SPDX check: OK
  • rg confirmed there are normal .cast links in the walkthrough and no .cast image embeds remain

No blocking issues found.

Copy link
Copy Markdown
Contributor

@jaxint jaxint left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great contribution! LGTM.

Copy link
Copy Markdown
Contributor

@jaxint jaxint left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great contribution! LGTM.

Copy link
Copy Markdown
Contributor

@jaxint jaxint left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great contribution! LGTM.

Copy link
Copy Markdown
Contributor

@jaxint jaxint left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great contribution! LGTM.

@508704820
Copy link
Copy Markdown
Contributor

Code Review: Fix installation walkthrough cast links

Summary

Simple but important documentation fix — replaces broken ![image](file.cast) syntax (asciinema .cast files aren't renderable as images in markdown) with proper link syntax [Watch the recording](file.cast).

Positive ✅

  • Correct fix: .cast files are asciinema recordings, not images
  • Also fixes relative path in README (INSTALLATION_WALKTHROUGH.mddocs/INSTALLATION_WALKTHROUGH.md)
  • Clean, minimal change

Minor Note

Consider adding the asciinema player embed code or a GIF preview as an alternative for browsers that don't handle .cast files natively. But this is an improvement over the broken image syntax.

LGTM

Copy link
Copy Markdown
Contributor

@jaxint jaxint left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great contribution! LGTM.

Copy link
Copy Markdown
Contributor

@jaxint jaxint left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great contribution! LGTM.

Copy link
Copy Markdown
Contributor

@508704820 508704820 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review: Fix Installation Walkthrough Cast Links

Summary

Replaces image syntax (...) with link syntax (Watch...) for asciinema recordings. .cast files are terminal recordings, not images — using image syntax renders them as broken images.

What Works Well

  1. Correct format: .cast files are text recordings, not renderable images
  2. Better UX: "Watch the recording" link text is more descriptive
  3. Both instances fixed: miner_install.cast and first_attestation.cast

Verdict: Approve

Correct fix — asciinema recordings need link syntax, not image syntax.

Copy link
Copy Markdown

@loganoe loganoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review for Scottcjn/rustchain-bounties#73 on current head d70a44c9c858776d24cec1303f0c6f0ab7f79a7c.

This is a narrow documentation rendering fix. The walkthrough now links to the committed asciinema .cast recordings instead of using Markdown image syntax, so GitHub will not render them as broken images while the local recording files remain reachable from docs/INSTALLATION_WALKTHROUGH.md.

Validation performed:

  • git diff --check origin/main...HEAD -- docs/INSTALLATION_WALKTHROUGH.md -> passed
  • Parsed docs/asciinema/miner_install.cast and docs/asciinema/first_attestation.cast line by line as JSON -> 46 and 76 JSON lines OK
  • python3 tools/bcos_spdx_check.py --base-ref origin/main -> OK
  • rg check found no remaining .cast image embeds in the walkthrough

No blocking issues found in this docs-only diff.

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 size/XS PR: 1-10 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants