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
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ name: Documentation
on:
push:
branches: [main]
paths: ['apps/**', 'packages/**', 'package.json', 'package-lock.json', '.github/workflows/docs.yml']
paths: ['apps/**', 'packages/**', 'vendor/**', '.npmrc', 'package.json', 'package-lock.json', '.github/workflows/docs.yml']
pull_request:
paths: ['apps/**', 'packages/**', 'package.json', 'package-lock.json', '.github/workflows/docs.yml']
paths: ['apps/**', 'packages/**', 'vendor/**', '.npmrc', 'package.json', 'package-lock.json', '.github/workflows/docs.yml']
workflow_dispatch:

permissions:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ apps/docs/next-env.d.ts
apps/docs/public/chart-demo/
*.tgz
packages/chart/assets/icons/preview.html
!vendor/bloxwap-hig/*.tgz
4 changes: 4 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# @bloxwap/hig-react declares optional exact Radix peers (dialog/popover 1.1.15) that conflict with
# Fumadocs (1.1.23). The docs import no HIG overlay entry, so keep npm from nesting duplicate Radix
# trees (which also detaches the packages/chart workspace link). See vendor/bloxwap-hig/README.md.
legacy-peer-deps=true
32 changes: 16 additions & 16 deletions apps/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,24 @@ path from the built artifact. It does not run Next.js or a search backend.

Edit MDX in `content/docs/` and sidebar order in each `meta.json`. The build
checks local HTML links and assets, and emits a browser-searchable index at
`search.json`. Fonts are local repository assets, so builds do not fetch Google Fonts.

The design follows `bloxwap/src/monorepo/workers/docs`: dark surfaces, green
accents, Bloxwap Sans body copy, Space Grotesk headings, and Bloxwap Mono code. The theme
is intentionally dark, matching the main Bloxwap docs.

- `styles/tokens.generated.css` is a vendored copy of the monorepo's
`packages/ui/src/styles/tokens.generated.css`. Update it from that source;
do not hand-edit generated tokens.
- `app/global.css` maps those tokens to Fumadocs and the playground wrapper,
using the same typography and navigation rules as the monorepo docs. The
embedded demo keeps the library's own appearance and controls.
`search.json`. Fonts come from the installed `@bloxwap/font` and `@bloxwap/hig-tokens` packages, so builds do not fetch Google Fonts.

The presentation follows the Bloxwap HIG and consumes it as packages, not copies:

- `@bloxwap/hig-tokens`, `@bloxwap/hig-contracts` and `@bloxwap/hig-react` are installed from the
pinned, unpublished candidate tarballs in [`vendor/bloxwap-hig/`](../../vendor/bloxwap-hig/README.md).
`app/global.css` imports `@bloxwap/hig-tokens/css` and `@bloxwap/hig-react/css` and maps HIG roles
onto Fumadocs; it does not declare palette values.
- `styles/hig-roles.generated.css` is generated from the package manifest by
`scripts/hig-tokens.mjs --write` (radius, type, motion and density roles the CSS distribution does not
emit yet). `npm run lint` fails on drift, tarball hash changes, copied palettes, `.btn`-style primitive
copies or font binaries in the docs source.
- Buttons, install tabs/copy, code-window copy, callouts, search error/empty states and the playground
loading status use HIG components (`Button`, `IconButton`, `Tabs`, `Surface`, `Callout`, `Alert`,
`EmptyState`, `Spinner`). The embedded demo keeps the SDK's own controls, themed from HIG roles.
- `public/logos/bloxwap-wordmark-white.svg` and `public/icon.svg` are the supplied
monorepo documentation artwork. Preserve the marks instead of typesetting them.
- `fonts/README.md` records font sources and licenses.

These copies keep this repository's GitHub Pages build independent of a sibling
monorepo checkout.

## Social cards

Expand Down Expand Up @@ -94,7 +94,7 @@ chrome's `--cts-font`/`--cts-mono` at Bloxwap Sans/Mono, and sets the canvas
`theme.fontFamily` to Bloxwap Sans and `monoFamily`/`scaleFontFamily` (status
line, drawing labels and scales) to Bloxwap Mono. The standalone playground and
SDK presets retain their existing font defaults.
Static social-image font provenance is recorded in `fonts/README.md`.
Social cards use the static Bloxwap Sans faces shipped in `@bloxwap/hig-tokens/fonts` (OFL).

HIG presentation, pinned candidate provenance, validation, exceptions and upgrade/rollback
instructions are recorded in [the adoption report](../../docs/hig-adoption/README.md).
2 changes: 1 addition & 1 deletion apps/docs/app/developers/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export default function Developers() {
<p className="eyebrow"><span className="status-dot" /> DEVELOPER PORTAL</p>
<h1>Build with the<br /><span>Chart SDK.</span></h1>
<p className="hero-description">Zero-dependency financial charts for your interface. Install the package, render your first candlestick chart in minutes, and let agents discover the API through the machine-readable resources below.</p>
<div className="hero-actions"><Link href="/docs/getting-started" className="btn">Start building <ArrowRight aria-hidden="true" /></Link><a href={repository} className="btn btn--secondary">Source on GitHub <ArrowRight aria-hidden="true" /></a></div>
<div className="hero-actions"><Link href="/docs/getting-started" className="hig-button" data-intent="primary">Start building <ArrowRight aria-hidden="true" /></Link><a href={repository} className="hig-button" data-intent="secondary">Source on GitHub <ArrowRight aria-hidden="true" /></a></div>
<InstallCommand />
</div>
</section>
Expand Down
Loading
Loading