Commit Graph

49 Commits

Author SHA1 Message Date
github-actions[bot] 4b89b265a6 Update README traction chart (#6075) 2026-08-18 13:19:27 +08:00
github-actions[bot] b308c581a5 Update README traction chart (#6047) 2026-08-18 13:04:55 +08:00
github-actions[bot] d41f8413ff Update README traction chart (#5560) 2026-08-11 20:13:34 +08:00
github-actions[bot] 1a4dcd7b0b Update README traction chart (#5232) 2026-07-28 08:43:46 +08:00
github-actions[bot] da121f460e Update README traction chart (#5072) 2026-07-26 15:25:07 +08:00
Ephraim Duncan 0d0977f692 docs: replace DevTools screenshots with interactive live demos (#5161)
Co-authored-by: Harry Yep <git@hode.co.uk>
2026-07-26 03:41:53 +08:00
github-actions[bot] 0bb825a258 chore: update README traction chart (#4745)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-07-06 22:26:43 +03:00
github-actions[bot] ea62054437 chore: update README traction chart (#4661) 2026-06-30 11:13:26 +08:00
github-actions[bot] 49ce0163c9 Update README traction chart (#4530) 2026-06-23 13:17:50 +08:00
Harry Yep 7b550dfd19 feat(devtools): render the inspector inline instead of a hosted iframe (#4433) 2026-06-16 17:48:43 +08:00
github-actions[bot] de8724be75 Update README traction chart (#4421) 2026-06-15 11:17:04 -07:00
github-actions[bot] 1053b2f913 Update README traction chart (#4341) 2026-06-11 11:28:34 +08:00
github-actions[bot] 66bc217c05 Update README traction chart (#4305) 2026-06-08 23:17:38 +08:00
github-actions[bot] 7ed54848be Update README traction chart (#4284) 2026-06-07 22:55:22 -07:00
github-actions[bot] b98920fcf1 Update README traction chart (#4281) 2026-06-06 16:57:38 -07:00
Shobhit Patra 1a7b3b48b8 docs: add dark mode variant of readme header (#4251)
Co-authored-by: Harry Yep <git@hode.co.uk>
2026-06-04 17:32:04 +08:00
github-actions[bot] fb664ca105 Update README traction chart (#4197) 2026-06-01 16:23:39 -07:00
github-actions[bot] 4555853529 Update README traction chart (#4106) 2026-05-25 15:12:52 +00:00
github-actions[bot] 0c4bd22921 Update README traction chart (#4055)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-05-20 05:53:16 +00:00
github-actions[bot] 7d49348120 Update README traction chart (#4011) 2026-05-16 00:44:47 +08:00
github-actions[bot] ab6987b67f Update README traction chart (#4006)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-05-10 15:22:22 -07:00
github-actions[bot] 4b12d72a76 Update README traction chart (#3947)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-05-09 14:11:09 +08:00
github-actions[bot] 177e50acc1 Update README traction chart (#3935)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-05-01 14:55:55 -07:00
github-actions[bot] e6fc8fd752 Update README traction chart (#3865)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-04-24 10:53:17 -07:00
github-actions[bot] 9cef2f1494 Update README traction chart (#3814)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-04-13 22:45:13 +08:00
github-actions[bot] a605a71fce Update README traction chart (#3776)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-04-06 12:24:57 -07:00
github-actions[bot] 1ac7c4e7f5 Update README traction chart (#3732)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-04-02 14:19:24 -07:00
github-actions[bot] 524eaa37cc Update README traction chart (#3691)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-03-23 10:52:40 -07:00
github-actions[bot] 85eb9fe80b Update README traction chart (#3649) 2026-03-16 19:53:45 -07:00
github-actions[bot] 44f0b00c4e Update README traction chart (#3551)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-03-12 15:25:03 -07:00
Ivan Masyuk c10d5a6c53 fix: improve README logo compatibility and readability (#3566)
## Summary

- Add Mastra and Iterable logos to the README traction section
- Fix all 10 company logos for GitHub SVG compatibility: convert `<text>` to path outlines, remove `xlink`/`<use>`/`<defs>`, strip near-1.0 opacity values, normalize viewBoxes
- Increase logo display height from 16px to 20px for better text readability
- Add `target="_blank"` to all logo links

## What changed

| File | Change |
|------|--------|
| `README.md` | **Updated.** Added Mastra (first) and Iterable logos, bumped all logo heights 16→20px, added `target="_blank"` to all 10 logo links |
| `.github/assets/logos/Mastra.svg` | **New.** Converted from source SVG, single-tone `#666`, viewBox cropped to content |
| `.github/assets/logos/Iterable.svg` | **New.** Multi-tone icon preserving depth hierarchy (`#666`/`#999`/`#aaa`), text converted to path outlines |
| `.github/assets/logos/Coreviz.svg` | **Rewritten.** Replaced `<text>` element (used `Fantasy` font) with Rajdhani Bold path outlines. SVGO optimized, viewBox cropped |
| `.github/assets/logos/Browser-Use.svg` | **Rewritten.** Replaced wrong-font text paths with Geist Sans Bold outlines generated via opentype.js. SVGO optimized |
| `.github/assets/logos/Athena-Intelligence.svg` | **Updated.** Inlined `<use xlink:href>` elements as `<path>`, removed `<defs>`. SVGO baked transform into coordinates, viewBox cropped |
| `.github/assets/logos/helicone.svg` | **Updated.** Removed 6 near-1.0 opacity attrs, normalized offset viewBox `(600 400 ...)` → `(0 0 ...)` via SVGO translate bake, viewBox cropped to content |
| `.github/assets/logos/LangChain.svg` | **Updated.** Removed no-op `clipPath`, empty `<defs>`, and unused `xmlns:xlink`. SVGO optimized |
| `.github/assets/logos/Inconvo.svg` | **Updated.** SVGO optimized |
| `.github/assets/logos/Stack.svg` | **Updated.** SVGO optimized |
| `.github/assets/logos/gram.svg` | **Updated.** SVGO optimized |

## GitHub SVG compatibility

GitHub's SVG sanitizer strips `<style>`, `<script>`, fonts, and can break `xlink` namespace references. All logos were hardened:

- **`<text>` → `<path>`**: GitHub can't render custom fonts, so text elements were converted to path outlines using opentype.js with the correct brand fonts (Rajdhani Bold for Coreviz, Geist Sans Bold for Browser Use)
- **`<use>`/xlink removed**: Athena Intelligence used `<defs>` + `<use xlink:href>` which GitHub can strip, leaving invisible elements. Inlined as direct `<path>` elements
- **Opacity flattened**: Helicone had opacity values of `.986`–`.994` (imperceptibly different from 1.0). Removed to simplify
- **ViewBox normalized**: Helicone's offset viewBox `(600 400 3030 700)` was normalized to `(0 0 ...)` by wrapping in a translate group and letting SVGO bake the coordinates
- **ViewBox cropped**: Removed dead space around content in Mastra, Coreviz, Iterable, Helicone, and Athena Intelligence to maximize rendered text size

<details>
<summary>Click to expand design decisions and rationale</summary>

### Text converted to path outlines, not kept as `<text>`
GitHub's SVG sanitizer strips all font references. The only reliable way to render text is as `<path>` outlines. We used opentype.js to load each brand's actual font (identified from their sites' CSS) and convert to paths.

### Multi-tone Iterable icon preserved with pre-blended hex values
Iterable's logo has white circle nodes, medium diamond intersections, and dark connecting lines. Instead of using `opacity` (which renders differently on light vs dark backgrounds), we pre-blended to fixed hex values: `#666` (dark), `#999` (medium), `#aaa` (light).

### Display height bumped from 16px to 20px
At 16px, several logos had text below 7px — particularly Athena Intelligence (~4.2px) and Helicone (~6.2px). Bumping to 20px (matching the SVGs' native height) gives a 25% size increase across the board, bringing all text to readable levels.

### ViewBox cropping instead of text rescaling
For logos where the icon defines the height (Coreviz, Iterable, Helicone, Athena), we cropped dead space from the viewBox rather than scaling text independently. This preserves the original logo proportions while maximizing the rendered size.

</details>

## Test plan

- [x] Opened all 10 SVGs individually in browser to verify rendering
- [x] Created HTML preview pages showing all logos inline at display size on both light and dark backgrounds
- [x] Verified bounding boxes via `getBBox()` to confirm viewBox crops don't clip content
- [x] Confirmed no remaining `xlink`, `<use>`, `<defs>`, `opacity`, or `<text>` elements across all logos
2026-03-09 18:36:38 -07:00
github-actions[bot] 2944f768d4 Update README traction chart (#3550)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-03-09 00:42:15 -07:00
github-actions[bot] 60962e6b63 Update README traction chart (#3468)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-03-02 16:30:34 -08:00
github-actions[bot] c7f10565da Update README traction chart (#3400)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-02-24 02:31:17 +08:00
github-actions[bot] b5036bf4e1 Update README traction chart (#3321)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-02-16 22:54:11 +08:00
github-actions[bot] ba2812c014 Update README traction chart (#3263)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-02-11 22:21:36 -05:00
github-actions[bot] e013a46608 Update README traction chart (#3193)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-02-03 14:15:46 -08:00
github-actions[bot] 69570593a1 Update README traction chart (#3125)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-01-26 10:00:05 -08:00
github-actions[bot] da2ddc418b Update README traction chart (#3081)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-01-20 16:26:41 -06:00
Ivan Masyuk 7c2d91a2ee Update README Traction Chart (#3077) 2026-01-20 14:05:35 -08:00
Simon Farshid 40fbfcd9c0 feat(docs add DevTools guide register in sidebar (#2532)
Add a new DevTools documentation page (docs/devtools.mdx) that
introduces the assistant-ui DevTools, shows a screenshot, and provides
a short setup walkthrough. The guide explains installation of the
@assistant-ui/react-devtools package, demonstrates how to mount the
DevToolsModal inside AssistantRuntimeProvider, and shows verification
steps with another screenshot.

Update docs meta (meta.json) to include the new "devtools" entry so the
page appears in the sidebar/navigation.

This adds developer-facing documentation to help debug assistant-ui
state and events without relying on console.log, improving onboarding
for contributors and integrators.
2025-09-25 13:46:40 -04:00
Bassim Shahidy 3568acf10f docs: Update README (#2222)
Update growth numbers and screenshot
2025-07-24 15:57:55 -04:00
Bassim Shahidy 49dc68548a chore(docs): Update README.md (#1998)
replace old `growth.png` with updated image
update monthly downloads number in readme to >100k
2025-05-23 15:40:31 -07:00
Simon Farshid 6aa9d98283 docs: update README (#1628) 2025-02-17 06:35:38 -08:00
Simon Farshid 24f2b1683d chore: update readme (#1627) 2025-02-17 06:30:21 -08:00
Simon Farshid f6b8390a97 docs: add a video tutorial for the starter CLI (#289) 2024-06-21 13:57:02 -07:00
Simon Farshid a0602a59b3 docs: grey header subtitle (#288) 2024-06-21 12:29:33 -07:00
Simon Farshid da5ac3faa6 docs: fix README header path (#286)
* docs: fix README header path

* remove border from header
2024-06-21 12:02:11 -07:00
Simon Farshid 2b9dca4d6c docs: add header to README (#285) 2024-06-21 11:58:41 -07:00