Skip to content

Commit 5b39493

Browse files
Merge pull request #36 from umage-ai/feature/readme-absolute-urls-v0.2.1
Make README links absolute + add release badge for v0.2.1
2 parents cc3fae0 + f93b9e0 commit 5b39493

2 files changed

Lines changed: 28 additions & 17 deletions

File tree

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# GraphSearchtools
22

33
[![Build](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/actions/workflows/publish.yml/badge.svg)](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/actions/workflows/publish.yml)
4-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
4+
[![Release](https://img.shields.io/github/v/release/umage-ai/Umage.Optimizely.GraphSearchtools?sort=semver)](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/releases/latest)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/blob/main/LICENSE)
56

67
Marketer-facing admin tooling for **Optimizely Graph** site-search on Optimizely CMS 12 and CMS 13. Pinned-result curation, synonym management, a per-channel try-it playground, and click-through / zero-result insights — all integrated into the CMS shell. Distributed as the NuGet package `UmageAI.Optimizely.GraphSearchTools`.
78

8-
![Channel detail](docs/screenshots/03-channel-detail.webp)
9+
![Channel detail](https://raw.githubusercontent.com/umage-ai/Umage.Optimizely.GraphSearchtools/main/docs/screenshots/03-channel-detail.webp)
910

1011
## Tools
1112

@@ -26,37 +27,37 @@ Behind the scenes the addon also exposes a public ingest beacon (`POST /api/tele
2627

2728
### Overview
2829

29-
![Overview](docs/screenshots/01-overview.webp)
30+
![Overview](https://raw.githubusercontent.com/umage-ai/Umage.Optimizely.GraphSearchtools/main/docs/screenshots/01-overview.webp)
3031

3132
Dashboard of all Graph Search Tools, with quick-access cards for each surface.
3233

3334
### Search channels
3435

35-
![Search channels](docs/screenshots/02-channels.webp)
36+
![Search channels](https://raw.githubusercontent.com/umage-ai/Umage.Optimizely.GraphSearchtools/main/docs/screenshots/02-channels.webp)
3637

3738
Index of every registered channel. Filter by site or locale. Activity sparkline and totals come from the search-log table so you can spot dormant surfaces at a glance.
3839

3940
### Channel detail
4041

41-
![Channel detail](docs/screenshots/03-channel-detail.webp)
42+
![Channel detail](https://raw.githubusercontent.com/umage-ai/Umage.Optimizely.GraphSearchtools/main/docs/screenshots/03-channel-detail.webp)
4243

4344
KPI strip (searches / CTR / zero-result) plus a Try-it live preview that runs the same GraphQL document your production storefront fires. The right pane swaps between **Insights** (per-channel top phrases / zero-result / low-CTR) and **Pinned / Synonyms / Settings** tabs without losing the preview state.
4445

4546
### Insights
4647

47-
![Insights](docs/screenshots/04-insights.webp)
48+
![Insights](https://raw.githubusercontent.com/umage-ai/Umage.Optimizely.GraphSearchtools/main/docs/screenshots/04-insights.webp)
4849

4950
Cross-channel marketer dashboard. Switch tabs between Top phrases, Zero-result phrases, and Low-CTR phrases; filter by channel, locale, and 24h / 7d / 30d window. The same window set scopes the Insights tab inside each Channel detail page, where it shares state with the Try-it preview.
5051

5152
### Pinned results
5253

53-
![Pinned results](docs/screenshots/05-pinned.webp)
54+
![Pinned results](https://raw.githubusercontent.com/umage-ai/Umage.Optimizely.GraphSearchtools/main/docs/screenshots/05-pinned.webp)
5455

5556
Tenant-wide pin browser. The **Pins** tab lists one row per `(phrase, collection, locale)` with the resolved channel link, item count, and last-30-days activity from search logs; a sibling **Collections** tab manages the underlying pinned-result collections, and **Changelog** records every create / update / delete sent to Graph.
5657

5758
### Synonyms
5859

59-
![Synonyms](docs/screenshots/06-synonyms.webp)
60+
![Synonyms](https://raw.githubusercontent.com/umage-ai/Umage.Optimizely.GraphSearchtools/main/docs/screenshots/06-synonyms.webp)
6061

6162
Replacement and equivalent rules per locale, with last-30-days activity. Graph synonyms live in a tenant-global pool, so this surface is channel-agnostic by design.
6263

@@ -200,13 +201,13 @@ Run on demand from the CMS admin Scheduled Jobs page.
200201

201202
## Documentation
202203

203-
- [Integrator quickstart](docs/integrator/quickstart.md) — install, register a search channel, and see a telemetry event in Insights.
204-
- [Server-rendered ASP.NET pattern](docs/integrator/pattern-server-rendered.md) — inject `ITelemetrySink` and emit events from your search controller.
205-
- [Headless deployment pattern](docs/integrator/pattern-headless.md) — beacon events from a SPA/SSR frontend to the public ingest endpoint.
206-
- [3rd-party telemetry pattern](docs/integrator/pattern-third-party-telemetry.md) — decorate `ITelemetrySink` to fan out, or replace `ITelemetryReader` to source aggregates from your own warehouse.
207-
- [Design system](docs/design-system.md) — shared visual patterns and components.
208-
- [Personas](docs/personas.md) — who the addon is designed for.
209-
- [Optimizely Graph research notes](docs/research/) — reference docs on Graph capabilities, relevancy, and authentication.
204+
- [Integrator quickstart](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/blob/main/docs/integrator/quickstart.md) — install, register a search channel, and see a telemetry event in Insights.
205+
- [Server-rendered ASP.NET pattern](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/blob/main/docs/integrator/pattern-server-rendered.md) — inject `ITelemetrySink` and emit events from your search controller.
206+
- [Headless deployment pattern](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/blob/main/docs/integrator/pattern-headless.md) — beacon events from a SPA/SSR frontend to the public ingest endpoint.
207+
- [3rd-party telemetry pattern](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/blob/main/docs/integrator/pattern-third-party-telemetry.md) — decorate `ITelemetrySink` to fan out, or replace `ITelemetryReader` to source aggregates from your own warehouse.
208+
- [Design system](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/blob/main/docs/design-system.md) — shared visual patterns and components.
209+
- [Personas](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/blob/main/docs/personas.md) — who the addon is designed for.
210+
- [Optimizely Graph research notes](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/tree/main/docs/research) — reference docs on Graph capabilities, relevancy, and authentication.
210211

211212
## Tech Stack
212213

@@ -219,10 +220,10 @@ Run on demand from the CMS admin Scheduled Jobs page.
219220

220221
## Contributing
221222

222-
See [`CLAUDE.md`](CLAUDE.md) for architecture patterns and conventions.
223+
See [`CLAUDE.md`](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/blob/main/CLAUDE.md) for architecture patterns and conventions.
223224

224225
## License
225226

226-
MIT — see [LICENSE](LICENSE).
227+
MIT — see [LICENSE](https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/blob/main/LICENSE).
227228

228229
Powered by [umage.ai](https://umage.ai).

RELEASE-NOTES.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Release Notes
22

3+
## v0.2.1
4+
5+
### Fixes
6+
7+
- **README images and doc links now render on nuget.org.** The packed `README.md` used repo-relative paths for screenshots, `LICENSE`, `CLAUDE.md`, and the `docs/` integrator guides, which resolve fine on GitHub but 404 from the nuget.org package page. All in-repo references are now absolute `https://github.com/umage-ai/Umage.Optimizely.GraphSearchtools/...` URLs (images via `raw.githubusercontent.com`).
8+
9+
### Changes
10+
11+
- **Added a Release badge** to the README header (`img.shields.io/github/v/release`) linking to the latest GitHub release. Sits between the existing Build and License badges.
12+
313
## v0.2.0
414

515
### Fixes

0 commit comments

Comments
 (0)