Skip to content

docs: align README with org template - #51

Merged
joeblau merged 1 commit into
mainfrom
cursor/align-readme-template-145b
Oct 12, 2026
Merged

joeblau merged 1 commit into
mainfrom
cursor/align-readme-template-145b

Conversation

@joeblau

@joeblau joeblau commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

Aligns the repository README with the bloxwap org template (https://github.com/bloxwap/.github/blob/main/README_TEMPLATE.md) merged in PR #5, following the reference implementation in bloxwap/sfx.

Changes

  • Section order: Moved Documentation before Development, Installation before Usage
  • Quick Example → Usage: Renamed the section per template convention
  • Features: Rewritten in 'Bold. Sentence.' voice with complete sentences
  • Em-dashes: Removed all em-dashes throughout the README
  • Release status: Moved to its own section after Installation per template
  • Coverage: Updated to "100% line, branch, and function coverage enforcement" (CI enforces it via check-coverage.mjs)
  • Badges: Updated to match template format (flat-square, simplified bundle size badge)
  • Development: Simplified command list with inline comments, moved npm ci and Node requirement to template structure
  • License: Changed to link format per template
  • Code comments: Removed numbered comments (// 1., // 2., // 3.) to match template convention

Verification

Docs build completed successfully:

Static export verified: 30 HTML pages, 1555 local links/assets, 25 social cards, basePath "/".

Full build output:

npm run docs:build
> docs:build
> npm --workspace @bloxwap/chart-docs run build


> @bloxwap/[email protected] prebuild
> npm --workspace @bloxwap/chart run build && node scripts/prepare-demo.mjs


> @bloxwap/[email protected] build
> npm run build:icons && npm run build:wasm && npm run build:ts


> @bloxwap/[email protected] build:icons
> npm run lint:icons && node scripts/build-icons.mjs


> @bloxwap/[email protected] lint:icons
> node scripts/lint-icons.mjs

icon lint: 137 icons clean (24×24 grid, 0.25 coordinate grid, repo-local)
src/ui/icons.ts regenerated: 137 icons (abcd.svg, anchored-note.svg, anchored-text.svg, anchored-vwap.svg, arc.svg, arrow-down.svg, arrow-marker.svg, arrow-up.svg, arrow.svg, bars-pattern.svg, brush.svg, callout.svg, chart-area.svg, chart-bar.svg, chart-candlestick.svg, chart-heikin-ashi.svg, chart-histogram.svg, chart-hollow-candlestick.svg, chart-line.svg, check.svg, chevron-down.svg, chevron-left.svg, chevron-right.svg, circle.svg, comment.svg, copy.svg, cross-line.svg, crosshair.svg, cursor-arrow.svg, cursor-cross.svg, cursor-demonstration.svg, cursor-dot.svg, curve.svg, cyclic-lines.svg, cypher.svg, date-price-range.svg, date-range.svg, disjoint-channel.svg, double-curve.svg, elliott-correction.svg, elliott-double-combo.svg, elliott-impulse.svg, elliott-triangle.svg, elliott-triple-combo.svg, ellipse.svg, emoji.svg, eraser.svg, extended-line.svg, eye-off.svg, eye.svg, fib-channel.svg, fib-circles.svg, fib-extension.svg, fib-speed-arcs.svg, fib-speed-fan.svg, fib-spiral.svg, fib-time-zone.svg, fib-time.svg, fib-wedge.svg, fib.svg, flag-mark.svg, flat-top-bottom.svg, forecast.svg, function-square.svg, gann-box.svg, gann-fan.svg, gann-square-fixed.svg, gann-square.svg, ghost-feed.svg, head-shoulders.svg, highlighter.svg, hline.svg, horizontal-ray.svg, icon.svg, image.svg, info-line.svg, inside-pitchfork.svg, lock.svg, long-position.svg, magnet-strong.svg, magnet.svg, modified-schiff-pitchfork.svg, monitor.svg, moon.svg, note.svg, order-book.svg, palette.svg, panel-left-close.svg, panel-left-open.svg, parallel-channel.svg, path.svg, pause.svg, pencil-lock.svg, pencil.svg, pin.svg, pitchfan.svg, pitchfork.svg, play.svg, polyline.svg, price-label.svg, price-note.svg, price-range.svg, projection.svg, range-profile.svg, ray.svg, rect.svg, redo.svg, regression-trend.svg, rotated-rect.svg, ruler.svg, schiff-pitchfork.svg, settings.svg, short-position.svg, signpost.svg, sine-line.svg, smile.svg, star-filled.svg, star.svg, sticker.svg, sun.svg, table.svg, text.svg, three-drives.svg, time-cycles.svg, trash.svg, trend-angle.svg, trendline.svg, triangle-pattern.svg, triangle.svg, undo.svg, unlock.svg, vertical-line.svg, volume-profile.svg, x.svg, xabcd.svg, zoom-in.svg, zoom-out.svg)

> @bloxwap/[email protected] build:wasm
> node scripts/build-wasm.mjs

wrote /workspace/packages/chart/src/wasm/kernels.base64.ts (1691 bytes wasm, 2256 chars base64)

> @bloxwap/[email protected] build:ts
> tsc -p tsconfig.json

Prepared the complete chart demo for the documentation site.

> @bloxwap/[email protected] build
> next build

▲ Next.js 16.3.6 (Turbopack)
[MDX] generated files in 7.266172999999981ms
✓ Running next.config.mjs took 227ms
Attention: Next.js now collects completely anonymous telemetry regarding usage.
This information is used to shape Next.js' roadmap and prioritize features.
You can learn more, including how to opt-out if you'd not like to participate in this anonymous program, by visiting the following URL:
https://nextjs.org/telemetry


  Creating an optimized production build ...
✓ Compiled successfully in 9.1s
  Running TypeScript ...
  Finished TypeScript in 2.3s ...
  Collecting page data using 3 workers ...
  Generating static pages using 3 workers (0/55) ...
  Generating static pages using 3 workers (13/55) 
  Generating static pages using 3 workers (27/55) 
  Generating static pages using 3 workers (41/55) 
✓ Generating static pages using 3 workers (55/55) in 1198ms
  Finalizing page optimization ...

Route (app)
┌ ○ /
├ ○ /_not-found
├ ○ /developers
├   /docs/[[...slug]]
│ ├ ● /docs/api/chart
│ ├ ● /docs/api/configuration
│ ├ ● /docs/api/exports
│ └ ● [+21 more paths]
├   /og/[...slug]
│ ├ ● /og/home.png
│ ├ ● /og/docs/api/chart.png
│ ├ ● /og/docs/api/configuration.png
│ └ ● [+22 more paths]
├ ○ /search.json
└ ○ /sitemap.xml


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


> @bloxwap/[email protected] postbuild
> node scripts/check-export.mjs

Static export verified: 30 HTML pages, 1555 local links/assets, 25 social cards, basePath "/".
Open in Web Open in Cursor 

@joeblau
joeblau marked this pull request as ready for review October 12, 2026 23:44
@joeblau
joeblau merged commit e08198b into main Oct 12, 2026
2 checks passed
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