Skip to content

docs: improve README with sfx-style header, plain comments, and reordered features - #178

Open
joeblau wants to merge 2 commits into
mainfrom
cursor/readme-improvements-60e3
Open

joeblau wants to merge 2 commits into
mainfrom
cursor/readme-improvements-60e3

Conversation

@joeblau

@joeblau joeblau commented Oct 13, 2026 •

Copy link
Copy Markdown

Summary

Improved the README.md to match the sfx style guide:

  • Added sfx-style h1 header (# @bloxwap/hyperliquid) with proper tagline format
  • Replaced em-dashes with plain sentences using commas or periods
  • Simplified code examples by removing numbered step comments (e.g., // 1. Import module → // Import module)
  • Moved "Tested" feature to the end of the Features list with honest wording about CI test suites

Changes

Header Format

  • Replaced HTML picture header with clean markdown h1
  • Added proper tagline: <p align="center"><strong>Blazing fast TypeScript SDK for Hyperliquid. <a href="...">Try the docs</a>.</strong></p>

Features Section

  • Reordered features to match sfx pattern with "Tested" at the end
  • Updated "Tested" description to accurately reflect CI: "Offline and online test suites run in CI."
  • Replaced em-dashes with commas or periods for better readability

Code Examples

  • Cleaned up all code examples to use plain comments instead of numbered steps
  • Maintained all functional content from the org template

Rebased

Docs Build Output

$ cd apps/docs && bun run build
$ fumadocs-mdx && next build && bun run scripts/export-markdown.ts && bun run scripts/verify-export.ts
[MDX] generated files in 8.560579000000018ms
▲ Next.js 16.3.8 (Turbopack)
[MDX] generated files in 7.884997999999996ms
✓ Running next.config.mjs took 264ms

  Creating an optimized production build ...
✓ Compiled successfully in 915ms
  Running TypeScript ...
  Finished TypeScript in 2.1s ...
  Collecting page data using 3 workers ...
  Generating static pages using 3 workers (0/37) ...
✓ Generating static pages using 3 workers (37/37) in 933ms
  Finalizing page optimization ...

Route (app)
┌ ○ /
├ ○ /_not-found
├ ○ /about
├ ○ /contact
├   /docs/[[...slug]]
│ ├ ● /docs
│ ├ ● /docs/clients
│ ├ ● /docs/error-handling
│ └ ● [+10 more paths]
├ ○ /llms-full.txt
├ ○ /llms.txt
├   /og/[...slug]
│ ├ ● /og/home.png
│ ├ ● /og/docs.png
│ ├ ● /og/docs/clients.png
│ └ ● [+11 more paths]
├ ○ /privacy
├ ○ /search-index.json
└ ○ /sitemap.xml

○  (Static)  prerendered as static content
●  (SSG)     prerendered as static HTML (uses generateStaticParams)

Exported 13 Markdown mirrors.
Verified 13 docs pages, 20 HTML files, 1185 internal links/assets, 355 anchors, 14 unique social cards, static search, 22 agent-readiness artifacts, and .nojekyll (base path: /).

Build completed successfully ✓

Open in Web Open in Cursor 

@cursor
cursor Bot force-pushed the cursor/readme-improvements-60e3 branch from 478ee0d to d80f49b Compare October 13, 2026 02:42

This branch has not been deployed

No deployments
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.

2 participants