From 49456c1b7b500eb5c5fa990aac322c2fe1ef818b Mon Sep 17 00:00:00 2001 From: Eva Date: Wed, 8 Jul 2026 19:11:19 +0700 Subject: [PATCH] docs: tighten GA dashboard launch setup --- README.md | 10 ++++++++++ docs/SETUP.md | 12 ++++++++++++ tests/public-release-readiness.test.ts | 4 ++++ 3 files changed, 26 insertions(+) diff --git a/README.md b/README.md index d903c8e5..09cfaf82 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,12 @@ Recommended package install for the current beta: npm install -g neondiff@0.4.30-beta.1 ``` +GA/latest package install path after the `v1.0.0` dist-tag cutover: + +```bash +npm install -g neondiff +``` + Installer script path: ```bash @@ -115,6 +121,10 @@ neondiff providers doctor --config config.local.json --json neondiff doctor --config config.local.json --json ``` +The local HTML dashboard is the first-run setup surface. It shows license status, +GitHub App status, daemon status, and provider readiness, and its provider card +includes a `Verify API Key` control that reports redacted pass/fail output. + Create or install the GitHub App before expecting PR reviews to run. The App must be installed on the same selected repositories listed in `pilotRepos`; see [docs/github-app-setup.md](docs/github-app-setup.md) for the permission set and diff --git a/docs/SETUP.md b/docs/SETUP.md index 0f4ec6d6..26a67790 100644 --- a/docs/SETUP.md +++ b/docs/SETUP.md @@ -32,6 +32,12 @@ Recommended package install: npm install -g neondiff@0.4.30-beta.1 ``` +GA/latest package install path after the `v1.0.0` dist-tag cutover: + +```bash +npm install -g neondiff +``` + Installer script: ```bash @@ -221,6 +227,12 @@ neondiff providers doctor --config config.local.json --json neondiff doctor --config config.local.json --json ``` +The local HTML dashboard is the human first-run surface. It shows license +status, GitHub App status, daemon status, and provider readiness with redacted +output. Use the provider card's `Verify API Key` button before launch/use; the +button checks the selected provider path and reports pass/fail without printing +the submitted key. + The full doctor output is JSON. Check: - `ok` diff --git a/tests/public-release-readiness.test.ts b/tests/public-release-readiness.test.ts index e3f324a2..a16b6611 100644 --- a/tests/public-release-readiness.test.ts +++ b/tests/public-release-readiness.test.ts @@ -224,6 +224,10 @@ describe("NeonDiff public release readiness", () => { expect(docs).toContain("https://github.com/electricsheephq/evaos-code-review-bot-neondiff"); expect(docs).toMatch(/npm install -g neondiff@0\.4\.30-beta\.1/i); + expect(docs).toMatch(/npm install -g neondiff(?!@)/i); + expect(docs).toMatch(/neondiff dashboard --config config\.local\.json/i); + expect(docs).toMatch(/Verify API Key/i); + expect(docs).toMatch(/license\s+status,\s+GitHub App status,\s+daemon status,\s+and provider readiness/i); expect(docs).toMatch(/curl -fsSL https:\/\/www\.neondiff\.com\/install/i); expect(docs).toContain("git clone https://github.com/electricsheephq/evaos-code-review-bot-neondiff.git"); expect(legacyRepoReferences).toEqual([]);