Skip to content

fix: restore ts sdk native packaging and gitbook header layout#99

Merged
Lythaeon merged 3 commits intomainfrom
fix/gitbook-navbar
Apr 12, 2026
Merged

fix: restore ts sdk native packaging and gitbook header layout#99
Lythaeon merged 3 commits intomainfrom
fix/gitbook-navbar

Conversation

@Lythaeon
Copy link
Copy Markdown
Owner

Description

Fix the GitBook top navigation layout and restore cross-platform TypeScript SDK native packaging in CI.

This PR addresses two concrete regressions:

  • the GitBook navbar was not truly centered on desktop widths and could crowd the search bar on narrower laptop-class widths
  • the TypeScript SDK native runtime packaging path regressed on macOS and Windows

Changes

  • docs/gitbook/_layouts/website/page.html
    • Split the header into explicit left / center / right regions so the top nav can be centered structurally instead of being pushed off-center by the search box.
  • docs/gitbook/styles/website.css
    • Reworked desktop header layout to use a centered nav column.
    • Added narrower-width behavior so the full topic nav hides before it overlaps the search field.
    • Preserved the existing mobile toggle path.
  • crates/sof-solana-gossip/src/node.rs
    • Gated Linux-only imports behind #[cfg(target_os = "linux")] so macOS builds do not fail under -D warnings.
  • .github/actions/rust-ci-setup/action.yml
    • Added a Windows Perl setup step for vendored OpenSSL builds used by the native runtime packaging path.
    • Exported PERL explicitly and verified the missing Perl module before Cargo runs.

Architecture/runtime/infra implications:

  • No SDK API change.
  • No runtime protocol change.
  • Release workflow behavior on Windows is tightened so vendored OpenSSL has a working Perl toolchain.

Motivation

Business motivation:

  • The docs navbar needs to remain readable and centered across common laptop widths.
  • The TypeScript SDK release matrix must work on macOS and Windows if the SDK is meant to be installable cross-platform.

Technical motivation:

  • The previous header grid could not actually center the nav because the search track sat to its left in the same layout flow.
  • The native SDK matrix was failing from platform-specific build issues rather than publish logic.

Alternative approaches considered:

  • Tweaking spacing only in CSS without restructuring the header. Rejected because it still left the nav structurally off-center.
  • Disabling vendored OpenSSL paths indirectly. Rejected for now in favor of making the existing release path work on the target runners.

Scope and impact

  • Affected slices: docs site header layout, release CI setup, vendored gossip dependency build path.
  • Data/API changes: none.
  • Backward compatibility: preserved.
  • Performance impact: none at runtime; docs header only.
  • Security impact: no reduction in checks; Windows CI setup now validates the Perl dependency required by vendored OpenSSL.

Testing

  • Unit tests
  • Integration tests
  • Manual verification
  • Performance checks (if applicable)
  • Security checks (if applicable)

Commands/results:

cargo check -p sof --features provider-websocket,provider-grpc,gossip-bootstrap
cargo fmt --all --check
npm --prefix docs/gitbook run build

Manual verification:

  • Verified the GitBook header locally in headless Chrome at 1600px, 1440px, 1320px, and 1280px widths.
  • Confirmed the nav is centered at desktop widths and hidden before overlap at narrower widths.
  • Triggered a dry-run release workflow on fix/gitbook-navbar: 24301873154.

Related issues and documentation

  • Fixes: release matrix regressions for TS SDK native packaging on macOS and Windows; GitBook navbar centering/layout regression.
  • Related: TypeScript SDK packaging and docs work on main.
  • Architecture docs: docs/architecture/README.md
  • Relevant ARD/ADR: none added in this PR.
  • Operations/runbook updates: none.

Reviewer checklist

  • Code follows project standards and architecture constraints
  • Slice boundaries are respected (docs/architecture/ard/0003-slice-dependency-contracts.md)
  • Tests added/updated and passing
  • Documentation updated (README/docs/operations as needed)
  • No undocumented breaking change
  • Performance trade-offs documented where relevant
  • Security considerations addressed where relevant

Additional notes

  • The branch dry-run release workflow is still running while this PR is opened.
  • At latest check, the previous macOS unused-import failure was fixed and the matrix had progressed into native package packing on all platforms.
  • One darwin-arm64 dry-run pack job has since failed again, and that follow-up failure is being investigated separately from the original regressions.

@Lythaeon Lythaeon merged commit 42d1fb4 into main Apr 12, 2026
3 checks passed
@Lythaeon Lythaeon deleted the fix/gitbook-navbar branch April 12, 2026 08:31
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