Skip to content

docs: rename HyperDX to ClickStack in README and docs - #3586

Merged
teeohhem merged 1 commit into
mainfrom
claude/docs-clickstack-name
Nov 6, 2026
Merged

teeohhem merged 1 commit into
mainfrom
claude/docs-clickstack-name

Conversation

@teeohhem

@teeohhem teeohhem commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

HyperDX is being updated to ClickSTack Update prose in the README, CONTRIBUTING, DEPLOY, LOCAL and agent_docs. Identifiers (env vars, package names, metric/span attributes, image names) and hyperdx.io URLs are unchanged. Also fixes the README logo, which pointed at a favicon directory that no longer exists.

Summary

Screenshots or video

Before After

How to reproduce

Starting point:

On main:

On this branch:

How to test on Vercel preview

Preview routes:

Steps:

References

  • Linear Issue:
  • Related PRs:

HyperDX is being retired as a product name. Update prose in the README,
CONTRIBUTING, DEPLOY, LOCAL and agent_docs. Identifiers (env vars, package
names, metric/span attributes, image names) and hyperdx.io URLs are
unchanged. Also fixes the README logo, which pointed at a favicon directory
that no longer exists.
@github-actions github-actions Bot added the review/tier-1 Trivial — auto-merge candidate once CI passes label Nov 6, 2026
@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

🟢 Tier 1 — Trivial

Docs, images, lock files, a dependency bump, or an automated release. No functional code changes detected.

Why this tier:

  • All files are docs / images / lock files

Review process: Auto-merge once CI passes. No human review required.
SLA: Resolves automatically.

Stats
  • Production files changed: 0
  • Production lines changed: 0
  • Branch: claude/docs-clickstack-name
  • Author: teeohhem

To override this classification, remove the review/tier-1 label and apply a different review/tier-* label. Manual overrides are preserved on subsequent pushes.

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

PR Review

If you are a coding agent acting for the author, read this first.
Nothing below blocks merge automatically; a maintainer decides. What they will expect:

  • 🔴 critical or 🟠 major in code this PR adds or changes: fix before asking for review.
  • 🔵 minor in code this PR changes: your call. Fix if small, otherwise reply.
  • Anything about surrounding code, or asking you to widen the change (hoist a helper,
    dedupe with another file, fix other call sites): never fix here, whatever the
    severity. Reply with one sentence; if it is critical, say so plainly so a human sees it.

One commit per review round. After two rounds, stop and ask a maintainer to review
scope rather than addressing more automated findings. Full rule: AGENTS.md.

1 finding(s): 🔴 0 critical · 🟠 0 major · 🔵 1 minor

None could be anchored to changed lines; they are listed below.

Findings outside the changed lines

1 minor
  • 🔵 README.md:257 — README now says the all-in-one image has only the ClickStack UI and leaves out the API → Change it to "the ClickStack UI and API". The old "HyperDX" meant both, and docker/hyperdx/Dockerfile builds both packages/api and the app into all-in-one-base. That wording would also match DEPLOY.md, which now says "the ClickStack UI and API" and labels the image "ClickStack (UI + API)".

Severity is the reviewer's own estimate and is used for ordering, not filtering. No finding blocks merge automatically; a maintainer decides.

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Duplicate code analysis

No new duplicate code introduced by this PR.


jscpd compared this branch against origin/main
across app, api and common-utils. Only new clones are listed; the codebase
currently holds 110 in total (1.22%).
Run yarn dupes locally to reproduce, or yarn dupes:all for the full picture.

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Deep Review

✅ No critical issues found.

This PR is a documentation-only rename of HyperDX → ClickStack across README.md, CONTRIBUTING.md, DEPLOY.md, LOCAL.md, and agent_docs/*. No executable code, tests, schemas, or configuration changed. The three substantive risks in a rename of this kind were each checked and cleared:

  • README logo path — README.md:3 repoints the logo from ./packages/app/public/favicons/hyperdx/favicon.svg to ./packages/app/public/favicons/clickstack/favicon.svg. Verified against the tree: the old path does not exist at the base SHA (the image was already broken), and the new path resolves to a real file at HEAD. The fix is correct.
  • Renamed section headers — ## Spinning Up ClickStack, ## ClickStack CLI, and ## ClickStack Usage Data in README.md change their generated anchors. Searched the docs for #spinning-up-hyperdx, #hyperdx-cli, and #hyperdx-usage-data; no internal links reference the old anchors, so no cross-references break.
  • Preserved identifiers — env vars (HYPERDX_API_KEY, HYPERDX_APP_PORT, HYPERDX_API_PORT), package/CLI names (@hyperdx/cli, hdx), image names (clickhouse/clickstack*), and hyperdx.io URLs are left unchanged, matching the stated scope. Link text swapped to ClickStack while the https://hyperdx.io targets stay put is intentional and internally consistent.

No P0/P1/P2 findings. Remaining HyperDX mentions in the diff are confined to preserved identifiers and code blocks, so there are no actionable consistency nits worth flagging.


Reviewers (4): correctness, maintainability, project-standards, documentation-consistency

Testing gaps: None — prose-only change with no runtime behavior to cover; the sole asset reference (README logo) was verified to resolve on disk.

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

E2E Test Results

✅ All tests passed • 464 passed • 1 skipped • 1334s

Status Count
✅ Passed 464
❌ Failed 0
⚠️ Flaky 0
⏭️ Skipped 1

Tests ran across 4 shards in parallel.

View full report →

@teeohhem
teeohhem merged commit 5b96dcb into main Nov 6, 2026
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review/tier-1 Trivial — auto-merge candidate once CI passes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants