Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
12 changes: 12 additions & 0 deletions docs/SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`
Expand Down
4 changes: 4 additions & 0 deletions tests/public-release-readiness.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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([]);
Expand Down
Loading