Skip to content

docs: versioning clarity, measured performance guidance, and fail-closed publishing - #7719

Merged
pixelcircuits merged 10 commits into
masterfrom
pixelcircuits/documentation-updates
Aug 21, 2026
Merged

pixelcircuits merged 10 commits into
masterfrom
pixelcircuits/documentation-updates

Conversation

@pixelcircuits

Copy link
Copy Markdown
Contributor

Summary

  • Clarify versioning across the README and book index: per-tag published books, the distinction between the docs source version, the Fuelup network channels, and the newest upstream release.
  • Add measured, evidence-scoped optimization guidance: storage read-once/write-once patterns, benchmarking the executed entrypoint with forc test --release --locked and a committed Forc.lock, and honest inline-assembly expectations — wins only where asm removes fixed-loop or branch scaffolding, with an isolated typed interface and a readable Sway oracle for differential testing.
  • Add predicate security-design guidance covering the transaction dimensions a predicate must bind (chain/domain, script, counts, owners/recipients/assets/amounts/net gain, nonces, validity windows, witness content).
  • Align the cargo-generate Rust test templates on one fuels version matched to the SDK harness, enforced by a CI check.
  • Make documentation publishing fail closed: the gh-pages workflow verifies plugin compatibility tags and only real tag pushes can move the latest redirect.

🤖 Generated with Claude Code

https://claude.ai/code/session_01NWti3Mzc7HHsy9EspKHKof

pixelcircuits and others added 5 commits July 23, 2026 16:49
Match the measured claim: assembly wins only when it removes fixed-loop
or branch scaffolding; straight-line arithmetic and asm inside the
original loop were gas-neutral or regressed. Add the isolation rule of
keeping a readable Sway oracle behind a typed interface, and use
--locked with a committed Forc.lock for comparative gas measurements.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NWti3Mzc7HHsy9EspKHKof
@pixelcircuits
pixelcircuits deployed to fuel-sway-bot August 21, 2026 13:01 — with GitHub Actions Active
@cursor

cursor Bot commented Aug 21, 2026 •

Copy link
Copy Markdown

PR Summary

Medium Risk
Changes GitHub Pages deploy conditions and plugin install pinning, which can block or mis-publish docs if tags/inputs are wrong. Template fuels bumps affect generated test projects.

Overview
Clarifies that GitHub Pages docs versions (latest, vX.Y.Z, master) are not Fuelup channels, and that Forc plugins can version independently of the compiler.

Adds measured performance and security notes: inline asm is not automatically cheaper, storage ops should be hoisted/written once, forc test --release must hit the real path, and predicates should bind transaction dimensions rather than only returning true. Marks Sway Applications as legacy snapshots.

Aligns cargo-generate Rust templates on fuels = "0.77" and extends the SDK harness version check so new templates cannot drift. The gh-pages workflow can backfill a tag, installs plugins from in-tree or pinned Forc tags (fail-closed otherwise), and only real tag pushes update the latest redirect.

Reviewed by Cursor Bugbot for commit a5ef996. Bugbot is set up for automated code reviews on this repo. Configure here.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using default effort and found 2 potential issues.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 6d3d7df. Configure here.

Comment thread .github/workflows/gh-pages.yml
Comment thread update_summary.md Outdated
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NWti3Mzc7HHsy9EspKHKof
@pixelcircuits
pixelcircuits deployed to fuel-sway-bot August 21, 2026 13:16 — with GitHub Actions Active
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NWti3Mzc7HHsy9EspKHKof
@pixelcircuits
pixelcircuits deployed to fuel-sway-bot August 21, 2026 13:44 — with GitHub Actions Active
A workflow_dispatch run started on a tag ref also satisfies a bare
startsWith(github.ref, 'refs/tags') check, so a manual backfill could
rewrite the latest redirect to an older tag. Require the push event so
only real tag pushes move latest; dispatch backfills still publish the
per-tag directories.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NWti3Mzc7HHsy9EspKHKof
@pixelcircuits
pixelcircuits deployed to fuel-sway-bot August 21, 2026 16:31 — with GitHub Actions Active
@pixelcircuits pixelcircuits self-assigned this Aug 21, 2026
@pixelcircuits
pixelcircuits deployed to fuel-sway-bot August 21, 2026 19:46 — with GitHub Actions Active
@pixelcircuits
pixelcircuits marked this pull request as ready for review August 21, 2026 20:00
@pixelcircuits
pixelcircuits requested review from a team as code owners August 21, 2026 20:00
@pixelcircuits
pixelcircuits deployed to fuel-sway-bot August 21, 2026 20:12 — with GitHub Actions Active
@pixelcircuits
pixelcircuits merged commit 08dad8c into master Aug 21, 2026
45 checks passed
@pixelcircuits
pixelcircuits deleted the pixelcircuits/documentation-updates branch August 21, 2026 21:21

This branch was successfully deployed

1 active deployment
fuel-sway-bot — a5ef9960 Deployed Aug 21, 2026 by pixelcircuits via forc-run-benchmarks #27147
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