Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,14 @@ jobs:
working-directory: apps/docs
run: bun run build

- name: Install browser for documentation checks
working-directory: apps/docs
run: bunx playwright install --with-deps chromium

- name: Test production documentation interactions
working-directory: apps/docs
run: bun run test:browser

- name: Check documentation links
uses: lycheeverse/lychee-action@e7477775783ea5526144ba13e8db5eec57747ce8 # v2
with:
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,6 @@ apps/docs/tsconfig.tsbuildinfo
# a funded key must never be committable.
.env
.env.*

apps/docs/test-results/
apps/docs/playwright-report/
20 changes: 12 additions & 8 deletions apps/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,18 @@ from the SDK package published from `packages/hyperliquid/dist`.

## Design system

The design follows the Bloxwap monorepo's documentation site at commit `15201923b`:
The shared presentation uses HIG 0.1.0 candidate at commit
`1a776b9326c6ba03702894943b3edbfd178c4b40` via the approved plain CSS distribution.

- `app/brand-tokens.css` is a verbatim snapshot of `packages/ui/src/styles/tokens.generated.css`.
- Fumadocs colors, typography, navigation, and forced dark mode follow `workers/docs/src/app/global.css` and its layouts.
- `@bloxwap/hig-docs-css` is a private local package; `vendor/hig/README.md` records provenance, hashes and update instructions.
- HIG tokens/CSS supply colors, controls, geometry and states; `app/global.css` adapts them to Fumadocs and the market playground.
- Fumadocs owns routing, navigation, search and MDX adapters; dark mode remains forced.
- The app icon and favicon in `public/logos/` preserve the original Bloxwap artwork and metadata.
- Bloxwap Sans body text and Bloxwap Mono code use the self-hosted Next.js exports from `@bloxwap/[email protected]`.
- Space Grotesk Bold headings retain the local asset and OFL notice in `public/fonts/`.
- Static Open Graph font instances and their license/provenance are documented in `public/fonts/README.md`.
- Headings/body use Bloxwap Sans and code uses Bloxwap Mono from self-hosted `@bloxwap/[email protected]` Next.js exports.
- Static Open Graph font instances retain the license/provenance documented in `public/fonts/README.md`.

Update these snapshots from the monorepo when its design changes. Keep the artwork and font notices intact.
Building this site does not require a checkout of the monorepo or a request to a font CDN.
Read the [HIG migration evidence](design-review/hig/README.md) for validation, measurements,
exceptions and rollback. No monorepo checkout, font CDN or npm publication is required.

The [historical design review](design-review/README.md) preserves the original findings and screenshots from 2026-09-26.

Expand Down Expand Up @@ -55,6 +56,9 @@ NEXT_PUBLIC_BASE_PATH=/hyperliquid bun run docs:build
NEXT_PUBLIC_BASE_PATH=/hyperliquid bun run docs:preview
```

Run `bun run --cwd apps/docs test:browser` after the production build to test the static shell
and market playground interactions. Install Chromium with `bunx --cwd apps/docs playwright install chromium`.

Open `http://localhost:4173/hyperliquid/`. The preview serves only the static files in `apps/docs/out`.
The build verifies every documentation page, internal link, asset, and anchor, plus the static JSON search index and
`.nojekyll`. It also checks each page's social metadata and its distinct 1200 × 630 PNG card.
Expand Down
172 changes: 0 additions & 172 deletions apps/docs/app/brand-tokens.css

This file was deleted.

Loading
Loading