Skip to content

docs: update all documentation for V8 rebuild and new API surface#8

Merged
yneves merged 1 commit into
mainfrom
docs/update-api-and-build-docs
May 20, 2026
Merged

docs: update all documentation for V8 rebuild and new API surface#8
yneves merged 1 commit into
mainfrom
docs/update-api-and-build-docs

Conversation

@yneves
Copy link
Copy Markdown
Collaborator

@yneves yneves commented May 20, 2026

Summary

  • docs/maintaining.md: Added full "V8 rebuild via GitHub Actions" section (matrix, GN args, why gcc on linux/amd64, archive splitting, assemble job). Expanded local rebuild section. Added "Platform-specific linker notes" (--start-group, gcc vs clang, use_thin_lto). Updated fork files conflict table (+10 entries).
  • docs/api-reference.md: Updated ArrayBuffer/SandboxEnabled descriptions for sandbox-disabled deps. Added missing helpers: StrictEquals, TypeOf, MarshalJSON, NewInstance, RetainedValueCount, IsExecutionTerminating.
  • docs/architecture.md: Added V8 build pipeline section with mermaid diagram and platform decision tree. Updated CGO file map. Added sandbox-disabled implications.
  • docs/release.md: Removed stale auto-bump-downstreams references. Added consolidated workflow inventory table.
  • docs/performance.md: Updated zero-copy ArrayBuffer section (sandbox now disabled, no caveat).
  • README.md: Updated fork additions list, added V8 rebuild section with CLI examples.
  • CHANGELOG.md: Expanded chess.5 with V8 sandbox disabled, fork-maintained deps, and build infrastructure entries.
  • docs/zero-cold-start.md: Noted sandbox is now disabled.

Test plan

  • CI passes (docs-only change, no code modifications)

- maintaining.md: add V8 rebuild via GitHub Actions section, expand
  local build docs, add platform-specific linker notes, update CGO
  surface drift and fork files tables
- api-reference.md: update sandbox/ArrayBuffer descriptions, add
  StrictEquals, TypeOf, MarshalJSON, NewInstance, RetainedValueCount,
  IsExecutionTerminating
- architecture.md: add V8 build pipeline section with mermaid diagram,
  update CGO file map, add sandbox-disabled implications
- release.md: remove auto-bump-downstreams refs, add workflow inventory
- performance.md: update zero-copy ArrayBuffer (sandbox now disabled)
- README.md: update fork additions, add V8 rebuild section
- CHANGELOG.md: expand chess.5 with V8 rebuild and build infra entries
- zero-cold-start.md: note sandbox is now disabled
@yneves yneves merged commit 6f4af9a into main May 20, 2026
2 checks passed
@yneves yneves deleted the docs/update-api-and-build-docs branch May 20, 2026 11:43
@yneves yneves self-assigned this May 20, 2026
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.

1 participant