Commit Graph

46 Commits

Author SHA1 Message Date
Harry Yep e8523cdd29 fix: base select popup rendering and dual-flavor docs polish (#4839) 2026-07-11 19:50:56 +08: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
Harry Yep 697f428169 docs: standardize package READMEs to a tier convention (#4007) 2026-05-11 11:27:41 +08: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
Ivan Masyuk 7c360ce5d1 Update npm README (#3377)
Signed-off-by: Ivan Masyuk <39418801+JustAnOkapi@users.noreply.github.com>
2026-02-20 15:36:57 -08:00
Ivan Masyuk 7c2d91a2ee Update README Traction Chart (#3077) 2026-01-20 14:05:35 -08:00
Bassim Shahidy d9c65e9560 docs: monthly downloads count in README (#3066)
Signed-off-by: Bassim Shahidy <122117267+AVGVSTVS96@users.noreply.github.com>
2026-01-19 19:17:24 -05:00
Harry Yep ab4b7919a6 refactor(docs): ui (#3037)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-01-16 14:03:29 +08:00
Harry Yep aee8561772 feat(react): dictation (#2810)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-01-14 23:52:13 +08:00
Pete Petrash a9e3c87a03 docs: update user stats and fix image display (#2706)
Update monthly downloads from >200k to >400k to reflect current usage 
statistics. Fix image rendering by replacing style attribute with width
attribute for better compatibility across platforms.
2025-11-07 10:08:36 -08:00
Pete Petrash 5c6f6557da Update growth image in README.md (#2705) 2025-11-07 08:57:34 -08:00
Konstantin Marunchenko fc740c53c6 Added a Manta graph button to README (#2606)
* Added Manta Graph button to README

* Update README.md

* Update README.md

Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>

---------

Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
2025-10-13 08:14:15 +00:00
Simon Farshid e67b29b324 docs: update readme and migration doc (#2424) 2025-09-08 10:49:08 -07:00
Simon Farshid 4230087196 fix: prettier formatting issues across the codebase (#2318)
- Fix trailing whitespace in prettier workflow
- Format JSON configuration files (settings, components, package.json, etc.)
- Format Markdown and MDX documentation files
- Fix CSS formatting in tailwindcss styles
- Update meta.json files formatting
- Fix HTML formatting in e-commerce example
- Ensure consistent formatting across all text files
2025-08-13 15:28:24 -07:00
Bassim Shahidy 6722bf2b50 docs: Update README (#2290)
* docs: Update README

* Update README.md
2025-08-11 17:47:12 -07:00
Bassim Shahidy 3568acf10f docs: Update README (#2222)
Update growth numbers and screenshot
2025-07-24 15:57:55 -04:00
Eric Liu 817c42b616 docs: fix typos (#2015)
* docs: Github --> GitHub

* docs: Typescript --> TypeScript

* oxford comma :)

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

---------

Co-authored-by: Bassim Shahidy <122117267+AVGVSTVS96@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
2025-05-26 17:11:37 -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 440b9eb1a7 readme: add deepwiki badge (#1999) 2025-05-23 13:52:12 -07:00
Simon Farshid 54b631c583 chore: update readme (#1629) 2025-02-17 06:47:13 -08: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 c5e15004b0 feat: add README for main package (#1594) 2025-02-11 02:40:38 -08:00
Simon Farshid 0b669d6713 fix: remove second parameter to CLI (#1593) 2025-02-10 13:16:26 -08:00
Simon Farshid cdc37e0a2a feat(cli): assistant-ui init (#1592)
* feat(cli): assistant-ui init

* version
2025-02-10 13:12:32 -08:00
Andrew Churchill b60f7a004f Add Weave badge to README (#1524) 2025-02-04 10:47:40 -08:00
Simon Farshid c481452797 docs: focus on shadcn (#1495)
* docs: focus on shadcn

* fixes
2025-02-02 14:18:33 -08:00
Simon Farshid 8d2f800bbb docs: new org (#1331) 2025-01-08 00:51:28 -08:00
Simon Farshid c626756679 fix: homepage URL (#1194)
* fix: homepage URL

* remove cli async main fns
2024-11-19 21:22:05 -08:00
Simon Farshid 30015d6b50 docs: use new CLI (#1183) 2024-11-19 15:25:14 -08:00
Hisham Khalifa 07107e9824 Update README.md - fixed link to docs (#936)
Docs pointed to https://assistant-ui.com/docs which was just a text dump. Fixed to point to https://assistant-ui.com/docs/getting-started.
2024-10-02 13:10:23 -07:00
Simon Farshid 015e288b46 docs(langgraph): add tutorial (#823) 2024-09-11 05:36:10 -07:00
Simon Farshid c92547de23 docs: add CONTRIBUTING.md (#642)
* docs: add CONTRIBUTING

* docs: move README to root
2024-08-04 10:51:01 -07:00
Simon Farshid 875c734d24 docs: move README to packages/react folder (#278) 2024-06-21 09:16:54 -07:00
Matthew Diakonov 48200243ac update shop example and readme (#273) 2024-06-20 21:02:09 -07:00
Simon Farshid 3810443a35 feat: assistant-ui create CLI (#272) 2024-06-20 19:47:17 -07:00
Simon Farshid 36f3a1f403 refactor: switch from biome to prettier + eslint (#266)
* refactor: switch from biome back to prettier + eslint

* run prettier

* fix build ,add changesets
2024-06-20 15:29:28 -07:00
Simon Farshid d3d4a348b1 fix: cli command in README (#195) 2024-06-15 20:31:16 -07:00
Simon Farshid 2c3b02f2fb fix: new import for AI SDK integration (#193) 2024-06-15 19:57:37 -07:00
Simon Farshid 38b52776a8 fix: use cross-spawn for Windows support (#185)
fixes #182
2024-06-14 21:54:29 -07:00
Simon Farshid 11c442614e docs: add discord (#187) 2024-06-14 17:02:15 -07:00
Simon Farshid 0f6478fe26 feat: move CLI to assistant-ui package (#170) 2024-06-12 13:46:49 -07:00
Simon Farshid a59b283b9e fix: minimal example (#169)
* fix: minimal example

* bump to 0.0.24
2024-06-11 23:16:00 -07:00
Simon Farshid 180b369370 docs: Update README (#162) 2024-06-11 09:35:02 -07:00
Simon Farshid 263850a938 feat: Add generative UI example (#61) 2024-06-01 12:32:00 -07:00
Simon Farshid 3964b8d7a3 Initial commit 2024-04-21 13:37:56 -07:00