Skip to content

docs: migrate Hyperliquid to HIG shell presentation - #179

Merged
joeblau merged 2 commits into
mainfrom
docs/hig-shell
Oct 14, 2026
Merged

joeblau merged 2 commits into
mainfrom
docs/hig-shell

Conversation

@joeblau

@joeblau joeblau commented Oct 14, 2026 •

Copy link
Copy Markdown

Migrates Hyperliquid’s shared docs presentation for bloxwap/hig #34. HIG 0.1.0 candidate tokens and CSS primitives replace the copied token palette; Bloxwap Sans now supplies headings, controls use HIG geometry/comfortable targets, and the footer follows content so it cannot cover the playground.

Fumadocs retains its navigation/search/MDX adapters. All 13 documentation pages, API examples, metadata, deep links, /hyperliquid static asset paths, and the market playground’s SDK transport/feed/reconnection logic are preserved. Shared clipboard handling now reports denial and cleans up timers; offline search failures have visible guidance.

HIG has no npm release (#32), so this uses the kit’s approved plain CSS path as a private local file package. The byte-identical upstream CSS, MIT license, source commit 1a776b9326c6ba03702894943b3edbfd178c4b40, and SHA-256 hashes are checked in. No npm publishing, tags/releases, or production deployment changes.

Validation and before/after screenshots, measurements, five-repository status matrix, exceptions and rollback instructions are in apps/docs/design-review/hig/README.md.

Validation:

  • bun run check: format, lint, content, SDK TS5/TS7, JSDoc, exports and import budgets pass (existing non-fatal lint warnings remain).
  • bun run docs:check: content/navigation checks and Next/TypeScript pass.
  • NEXT_PUBLIC_BASE_PATH=/hyperliquid bun run docs:build: production static export passes; 13 docs pages, 20 HTML files, 1,168 internal links/assets, 355 anchors, 14 unique social cards and 22 agent artifacts verified.
  • bun run build: SDK build passes.
  • bun run test:offline --timeout 30000: 2,087 pass, 244 skip, 0 fail, 76,722 assertions across 255 files. An initial five-second timeout in the unchanged HIP-3 schema fixture under VM memory pressure prompted a full rerun with unchanged assertions. Docs helpers: 10 pass, 0 fail.
  • bun run --cwd apps/docs test:browser: six tests pass against the production export. Covers keyboard install, clipboard success/denial, search/empty/offline states, mobile sidebar/deep links, large text/RTL, real SDK subscriptions using deterministic WebSocket frames, payload/asset/off/loading/rejection/retry behavior and footer non-overlap. Added to docs CI.
  • A separate unmocked Chromium session reached Live and received a BTC mid-price; timestamp/payload are in live-market.json.

Full-export CSS: 159,189 → 158,685 bytes; JS: 1,355,870 → 1,356,112 bytes. The original Space Grotesk TTF removes 116,056 bytes; copied token CSS removes 5,921 bytes. Export totals include cache-retained font assets and are not initial-load measurements.

Exceptions: candidate distribution pending #32 publication, Fumadocs host adapters intentionally retained. Physical iOS/Android devices, VoiceOver/TalkBack, tactile feedback and wide-gamut fidelity cannot be certified on this Linux VM. No hardware result is claimed. This PR covers the Hyperliquid row only; #34 remains open for the other four migrations and upstream adoption-ledger reconciliation. Do not close the cross-repository issue from this PR.

Final CI on 5e6d02a9cc27d0b47048549658d5015b5cb0b345: documentation/build/types/browser/link checks, code quality, offline tests, security, and performance attempt 2 all pass. gh pr checks --watch completed successfully; the deployment job is skipped for this PR.

Performance transparency: the two initial CI runs flagged different SDK microbenchmarks (l1_action_hash_with_vault_and_expiry and canonicalize_order_1). SDK source, benchmark source, thresholds and performance workflow have no diff from the base. Rerunning the same final-head job passed without code/gate changes; no performance threshold was loosened and no retry logic was added. Local transient failures and their full unchanged-assertion rerun are described above.

@joeblau
joeblau merged commit 33e42d7 into main Oct 14, 2026
6 of 7 checks passed
@joeblau
joeblau deleted the docs/hig-shell branch October 14, 2026 02:38
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