Skip to content

Evenfire is an intelligence layer platform for running LLM agents that take real actions, on your infrastructure

TypeScript

docs(desktop-app): drop spec citations from onboarding comments

Andy Paviacc3f509b7c93
diff --git a/desktop-app/src/__tests__/appService.onboarding.test.ts b/desktop-app/src/__tests__/appService.onboarding.test.ts
index c84f087c4..5ea2273cf 100644
--- a/desktop-app/src/__tests__/appService.onboarding.test.ts
+++ b/desktop-app/src/__tests__/appService.onboarding.test.ts
@@ -100,7 +100,7 @@ describe('onboarding main-process surface', () => {
await service.probeLocalhostReachable()
// The renderer cannot name a URL for the main process to fetch, so the
- // remote environment must never be contacted by this call (spec §6.8).
+ // remote environment must never be contacted by this call.
expect(service.authClient.healthAt).toHaveBeenCalledTimes(1)
expect(service.authClient.healthAt.mock.calls[0]?.[0]).toBe(LOCALHOST_EXTERNAL)
})
@@ -116,7 +116,7 @@ describe('onboarding main-process surface', () => {
const opened = String(openExternal.mock.calls[0]?.[0] || '')
expect(opened).toMatch(/^https:\/\//)
// Self-hosting covers any cluster the user controls, so the link must not
- // land on the local-cluster quickstart (spec §5.4).
+ // land on the local-cluster quickstart.
expect(opened).not.toMatch(/minikube|quickstart/i)
})
})
diff --git a/desktop-app/src/appService.ts b/desktop-app/src/appService.ts
index 73c4bc792..60ba30429 100644
--- a/desktop-app/src/appService.ts
+++ b/desktop-app/src/appService.ts
@@ -1173,7 +1173,7 @@ export class AppService {
/**
* Monotonic per sandbox-ui mount. Carried into the SDK surface pin so a
* request from a superseded embed can be told apart from the live one
- * (spec §8.1), mirroring the driver's own `mountGeneration` guard.
+ *, mirroring the driver's own `mountGeneration` guard.
*/
private sandboxUiGeneration = 0
@@ -1761,7 +1761,7 @@ export class AppService {
}
/**
- * Onboarding's path-D hint (spec §5.6): is a local Evenfire answering?
+ * Onboarding's local-cluster hint: is a local Evenfire answering?
*
* Takes **no argument** on purpose. The renderer cannot name a URL for the
* main process to fetch — it can only ask about the built-in Localhost
@@ -1778,8 +1778,8 @@ export class AppService {
}
/**
- * Open the deployment documentation for onboarding's self-hosted path
- * (spec §5.4). The URL is a build-time constant, not a renderer argument.
+ * Open the deployment documentation for onboarding's self-hosted answer
+ *. The URL is a build-time constant, not a renderer argument.
*/
async openDeploymentDocs(): Promise<{ opened: true }> {
const { shell } = await import('electron')
@@ -1788,7 +1788,7 @@ export class AppService {
}
/**
- * Open the hosted Evenfire site for onboarding's hosted path (spec §5.3).
+ * Open the hosted Evenfire site for onboarding's hosted answer.
* Also a build-time constant. No credentials, no tenant name and no nonce
* cross this boundary — the app only opens a page.
*/
@@ -3039,7 +3039,7 @@ export class AppService {
this.stopAllStreams()
// Grants are keyed by userId, not by team, so they carry over — but every
// cached org/agents/contexts answer is now about the wrong team. Drop the
- // cache and tell mounted plugins to refetch (spec §6.2).
+ // cache and tell mounted plugins to refetch.
tryGetPluginSdkRuntime()?.notifySessionChanged(true)
return { authenticated: true, me: this.me }
} finally {
@@ -3090,7 +3090,7 @@ export class AppService {
// boundary for the desktop catalog: the `|| name` guard lives here only
// (mirroring control-api's accessReconciliation `configuredDisplayName ||
// name`), so renderer consumers read `agentDisplayByName[name]` directly
- // without sprinkling `|| name` (spec Decision #6). Filled total over
+ // without sprinkling `|| name`. Filled total over
// `agentNames` below so a lookup is never undefined.
const agentDisplayByName: Record<string, string> = {}
const upsertScopedServers = (
@@ -4605,7 +4605,7 @@ export class AppService {
return
}
// Pin the surface so the SDK broker can derive this plugin's identity from
- // `webContents.id` — the plugin never asserts who it is (spec §8.1).
+ // `webContents.id` — the plugin never asserts who it is.
tryGetPluginSdkRuntime()?.pinSandboxUiSurface({
pluginId: activeView.appRef,
pluginTitle: String(args.title || '').trim() || recipeName,
diff --git a/desktop-app/src/config.ts b/desktop-app/src/config.ts
index c19dd2d39..cac98035d 100644
--- a/desktop-app/src/config.ts
+++ b/desktop-app/src/config.ts
@@ -49,14 +49,14 @@ const DEFAULT_APP_NAME = 'Evenfire'
const LOCALHOST_OPTION_ID = '__localhost__'
const LOCALHOST_EXTERNAL_REST_API_BASE_URL = 'http://127.0.0.1:8091'
const LOCALHOST_RPC_PROXY_BASE_URL = 'http://127.0.0.1:8094'
-// Where onboarding's self-hosted path sends the user (spec §5.4). Self-hosting
+// Where onboarding's self-hosted path sends the user. Self-hosting
// means any cluster the user controls — remote or local — so this must land on
// documentation that covers both shapes, never on the minikube quickstart
// alone. A build-time constant, overridable only where the dev env config gate
// already allows overrides, so a packaged build cannot be pointed elsewhere.
const DEFAULT_DEPLOYMENT_DOCS_URL =
'https://github.com/evenfire-ai/evenfire#deploying-to-a-remote-cluster'
-// Where onboarding's hosted path sends the user (spec §5.3). Today this is the
+// Where onboarding's hosted path sends the user. Today this is the
// marketing site, not a signup endpoint: there is no tenant provisioning and no
// evenfire://desktop-environment handoff yet, so the hosted step links out and
// offers the manual-address fallback for when the user returns with a server.
@@ -64,7 +64,7 @@ const DEFAULT_DEPLOYMENT_DOCS_URL =
const DEFAULT_HOSTED_SIGNUP_URL = 'https://evenfire.ai'
const RUNTIME_CONFIG_DIR_NAME = 'runtime-configs'
/**
- * Dev switch for previewing the first-run onboarding flow (spec §5.1) on a
+ * Dev switch for previewing the first-run onboarding flow on a
* machine that already has environments configured. Defaults to false; only
* the exact string "true" enables it.
*
@@ -791,7 +791,7 @@ export async function saveDesktopRuntimeConfig(next: DesktopRuntimeConfig): Prom
/**
* Derive the environment namespacing key from a runtime config's external-rest-api
- * and rpc-proxy base origins (spec §5.1, D1). Same REST origin + different RPC
+ * and rpc-proxy base origins. Same REST origin + different RPC
* origin is a different runtime boundary because desktop session tokens are
* accepted by the RPC proxy, not by external-rest-api alone.
*
diff --git a/desktop-app/src/ipc.ts b/desktop-app/src/ipc.ts
index 2ba326d4b..2e5ebcbfd 100644
--- a/desktop-app/src/ipc.ts
+++ b/desktop-app/src/ipc.ts
@@ -1792,7 +1792,7 @@ export function registerIpcHandlers(service: AppService): void {
// The consent resolve channel IS trusted-sender guarded. That is what stops
// an embed from answering its own permission prompt, and it pairs with the
// main-generated `promptId` nonce: a resolve for an unknown or already-
- // answered prompt is dropped inside the gate (spec §9.4).
+ // answered prompt is dropped inside the gate.
ipcMain.handle(
PLUGIN_SDK_CONSENT_RESOLVE_CHANNEL,
diff --git a/desktop-app/ui/src/App.tsx b/desktop-app/ui/src/App.tsx
index 8d9abca07..3c3c48ec7 100644
--- a/desktop-app/ui/src/App.tsx
+++ b/desktop-app/ui/src/App.tsx
@@ -428,7 +428,7 @@ export function App() {
activeConversationOriginRef.current = activeConversationOrigin
/**
- * Plugin permission prompts (spec §9). Main hides the plugin's
+ * Plugin permission prompts. Main hides the plugin's
* `WebContentsView` before pushing the request and restores it once the user
* answers, so the plugin can neither fake the prompt nor paint over it. The
* prompt is centered over — and its backdrop scoped to — the plugin's embed
diff --git a/desktop-app/ui/src/components/RuntimeConfigDock/index.tsx b/desktop-app/ui/src/components/RuntimeConfigDock/index.tsx
index 17d0aaab7..f0f0a6f42 100644
--- a/desktop-app/ui/src/components/RuntimeConfigDock/index.tsx
+++ b/desktop-app/ui/src/components/RuntimeConfigDock/index.tsx
@@ -13,7 +13,7 @@ interface RuntimeConfigDockProps {
/**
* Where "Add environment" goes. AuthPage opens its inline environment form;
* onboarding moves to its manual step. The dock itself stays identical, so
- * the Localhost escape hatch (spec §3, path E) is reachable from both — a
+ * the Localhost escape hatch is reachable from both — a
* cold install renders onboarding, not AuthPage, and would otherwise have no
* way to reach it.
*/
diff --git a/desktop-app/ui/src/hooks/domain/useOnboardingController.ts b/desktop-app/ui/src/hooks/domain/useOnboardingController.ts
index 3606d9432..590e9b2e2 100644
--- a/desktop-app/ui/src/hooks/domain/useOnboardingController.ts
+++ b/desktop-app/ui/src/hooks/domain/useOnboardingController.ts
@@ -7,7 +7,7 @@ import type {
} from '@pages/OnboardingPage/types'
/**
- * Whether the hosted path (spec §5.3) is offered in Q2.
+ * Whether the hosted path is offered in Q2.
*
* True: hosting is the first thing someone just getting started should see,
* and the hosted step has somewhere real to send them — the Evenfire site.
@@ -26,7 +26,7 @@ interface OnboardingState {
const INITIAL_STATE: OnboardingState = { step: 'origin', history: [] }
/**
- * Onboarding wizard state (spec §5.1, §5.2).
+ * Onboarding wizard state.
*
* Memory-only by design. A cold install closed mid-questionnaire comes back to
* Q1: nothing was accomplished worth restoring, and persisting a half-answered
diff --git a/desktop-app/ui/src/hooks/useAppController.ts b/desktop-app/ui/src/hooks/useAppController.ts
index 74a0bb5f4..24296bc3e 100644
--- a/desktop-app/ui/src/hooks/useAppController.ts
+++ b/desktop-app/ui/src/hooks/useAppController.ts
@@ -172,7 +172,7 @@ export function useAppController() {
// ─── First-run onboarding ───
const onboarding = useOnboardingController()
// Onboarding owns the unauthenticated screen only while the app has no
- // environment at all (spec §5.1). Saving one — or selecting Localhost —
+ // environment at all. Saving one — or selecting Localhost —
// flips `configured`, which retires the wizard; deleting the last one brings
// it back rather than leaving a sign-in form with nothing to sign in to.
const unauthenticatedView = selectUnauthenticatedView({
@@ -552,7 +552,7 @@ export function useAppController() {
if (!sessionState.authenticated || !sessionState.me) {
throw new Error('Team switch ended without an authenticated session')
}
- // GAP-N4 (spec §4.5-3): the renderer half of a team switch. `clearActiveChat`
+ // GAP-N4: the renderer half of a team switch. `clearActiveChat`
// only deselects — the previous team's tracker entries and FSM projection
// survive, so a late terminal from an old-team task could run side effects
// and stale badges leak across teams. Tear down the renderer chat state
@@ -746,7 +746,7 @@ export function useAppController() {
teamsData.reset()
resetWorkflowsData()
queryClient.removeQueries({ queryKey: desktopQueryKeys.gfsRoot })
- // Drop ALL cached queries on logout (spec §5.2 P1): the singleton
+ // Drop ALL cached queries on logout: the singleton
// desktopQueryClient uses staleTime:Infinity, so any env-scoped data left
// in cache would otherwise bleed into the next login (possibly a different
// environment, since the env is chosen pre-login).
diff --git a/desktop-app/ui/src/hooks/useLocalhostReachable.ts b/desktop-app/ui/src/hooks/useLocalhostReachable.ts
index 0bd19f266..8b35c8555 100644
--- a/desktop-app/ui/src/hooks/useLocalhostReachable.ts
+++ b/desktop-app/ui/src/hooks/useLocalhostReachable.ts
@@ -1,7 +1,7 @@
import { useEffect, useState } from 'react'
/**
- * Whether a local Evenfire is answering on this machine (spec §5.6).
+ * Whether a local Evenfire is answering on this machine.
*
* One bounded probe per mount. The main process takes no URL — it only ever
* checks the built-in Localhost option — so the renderer cannot use this to
diff --git a/desktop-app/ui/src/lib/unauthenticatedView.ts b/desktop-app/ui/src/lib/unauthenticatedView.ts
index de815f146..c9581d5bd 100644
--- a/desktop-app/ui/src/lib/unauthenticatedView.ts
+++ b/desktop-app/ui/src/lib/unauthenticatedView.ts
@@ -7,7 +7,7 @@ interface UnauthenticatedViewInput {
}
/**
- * Which screen the unauthenticated branch renders (spec §4.1).
+ * Which screen the unauthenticated branch renders.
*
* Order matters: an outage wins over everything, because neither signing in
* nor onboarding can succeed while a dependency is down. Onboarding comes
diff --git a/desktop-app/ui/src/pages/AuthPage/index.tsx b/desktop-app/ui/src/pages/AuthPage/index.tsx
index e9585bdec..804edd5e8 100644
--- a/desktop-app/ui/src/pages/AuthPage/index.tsx
+++ b/desktop-app/ui/src/pages/AuthPage/index.tsx
@@ -9,8 +9,8 @@ import { RuntimeConfigDock } from '@components/RuntimeConfigDock'
* Sign-in for a configured environment.
*
* A cold install never reaches this page — the unauthenticated branch renders
- * onboarding instead (spec §4.1), so the invitation email form that used to
- * live here now belongs to the wizard's invited step (spec §5.5). AuthPage has
+ * onboarding instead, so the invitation email form that used to
+ * live here now belongs to the wizard's invited step. AuthPage has
* exactly one mode again: sign in, plus the environment dock and its inline
* add-environment form.
*/
diff --git a/desktop-app/ui/src/pages/OnboardingPage/index.tsx b/desktop-app/ui/src/pages/OnboardingPage/index.tsx
index c4507bebb..1fb79c73f 100644
--- a/desktop-app/ui/src/pages/OnboardingPage/index.tsx
+++ b/desktop-app/ui/src/pages/OnboardingPage/index.tsx
@@ -13,10 +13,10 @@ interface OnboardingPageProps {
}
/**
- * First-run onboarding (spec §5.2).
+ * First-run onboarding.
*
* Rendered instead of AuthPage when the app has no environment at all, so it
- * also carries the environment dock: the Localhost escape hatch (path E) lives
+ * also carries the environment dock: the Localhost escape hatch lives
* there, and a cold install would otherwise have no way to reach it.
*/
export function OnboardingPage({ onboarding }: OnboardingPageProps) {
diff --git a/desktop-app/ui/src/pages/OnboardingPage/steps/Hosted.tsx b/desktop-app/ui/src/pages/OnboardingPage/steps/Hosted.tsx
index df03a7e30..1047debe8 100644
--- a/desktop-app/ui/src/pages/OnboardingPage/steps/Hosted.tsx
+++ b/desktop-app/ui/src/pages/OnboardingPage/steps/Hosted.tsx
@@ -6,7 +6,7 @@ interface HostedProps {
}
/**
- * Path A — Evenfire-hosted (spec §5.3), in its link-out form.
+ * Evenfire-hosted, in its link-out form.
*
* The hosted signup project does not exist yet: there is no tenant
* provisioning and no `evenfire://desktop-environment` handoff back into the
diff --git a/desktop-app/ui/src/pages/OnboardingPage/steps/InvitedMember.tsx b/desktop-app/ui/src/pages/OnboardingPage/steps/InvitedMember.tsx
index 3eb10d64a..115de8e7a 100644
--- a/desktop-app/ui/src/pages/OnboardingPage/steps/InvitedMember.tsx
+++ b/desktop-app/ui/src/pages/OnboardingPage/steps/InvitedMember.tsx
@@ -3,7 +3,7 @@ import { useAuthContext } from '@contexts/AuthContext'
import { Button, Field, TextInput } from '@components/Common'
/**
- * Path C — invited member (spec §5.5).
+ * Invited member: finish setup for an address a team already invited.
*
* Behaviour is unchanged from the form this replaces on AuthPage: the same
* `handleStartDesktopSetup` handler, the same single email field, the same
diff --git a/desktop-app/ui/src/pages/OnboardingPage/steps/ManualEnvironment.tsx b/desktop-app/ui/src/pages/OnboardingPage/steps/ManualEnvironment.tsx
index 282fe2947..21722cc61 100644
--- a/desktop-app/ui/src/pages/OnboardingPage/steps/ManualEnvironment.tsx
+++ b/desktop-app/ui/src/pages/OnboardingPage/steps/ManualEnvironment.tsx
@@ -8,9 +8,9 @@ import {
import { useLocalhostReachable } from '@hooks/useLocalhostReachable'
/**
- * Path D — manual environment (spec §5.6).
+ * Manual environment: connect to a server by address.
*
- * The terminal step for paths B and D alike, so it carries the local-cluster
+ * The terminal step for the self-hosted and have-an-address answers alike, so it carries the local-cluster
* hint for both. It shares `handleSaveRuntimeConfig` with AuthPage's inline
* environment form: one submit path, one validation rule.
*/
@@ -25,7 +25,7 @@ export function ManualEnvironment() {
handleSelectRuntimeConfig,
} = useAuthContext()
- // One bounded probe on entry (spec §9.4). A negative or failed result
+ // One bounded probe on entry. A negative or failed result
// renders nothing, so a user with no local cluster sees no trace of it. The
// probe never fills the form or saves on its own.
const localhostReachable = useLocalhostReachable()
diff --git a/desktop-app/ui/src/pages/OnboardingPage/steps/PathChoice.tsx b/desktop-app/ui/src/pages/OnboardingPage/steps/PathChoice.tsx
index c462322c1..58543d2c4 100644
--- a/desktop-app/ui/src/pages/OnboardingPage/steps/PathChoice.tsx
+++ b/desktop-app/ui/src/pages/OnboardingPage/steps/PathChoice.tsx
@@ -8,7 +8,7 @@ interface PathChoiceProps {
}
/**
- * The questionnaire itself — Q1, and Q2 once the hosted path ships (spec §3).
+ * The questionnaire itself — Q1, and Q2 once the hosted path ships.
*
* Q1's "I have a server address" doubles as the wizard's one-click skip, which
* is why the first step needs no separate skip control.
diff --git a/desktop-app/ui/src/pages/OnboardingPage/steps/SelfHosted.tsx b/desktop-app/ui/src/pages/OnboardingPage/steps/SelfHosted.tsx
index 6dd320e73..05fe378bd 100644
--- a/desktop-app/ui/src/pages/OnboardingPage/steps/SelfHosted.tsx
+++ b/desktop-app/ui/src/pages/OnboardingPage/steps/SelfHosted.tsx
@@ -6,11 +6,11 @@ interface SelfHostedProps {
}
/**
- * Path B — self-hosted (spec §5.4).
+ * Self-hosted.
*
* Documentation-first: deployment shapes differ too much for a wizard to guide
* any of them honestly, so this step names the option, links out, and hands to
- * path D. It deliberately shows no prerequisites, no install command and no
+ * the manual environment step. It deliberately shows no prerequisites, no install command and no
* default address — all three would assume a deployment shape, and
* self-hosting means any cluster the user controls, remote or local.
*/
diff --git a/desktop-app/ui/src/pages/OnboardingPage/types.ts b/desktop-app/ui/src/pages/OnboardingPage/types.ts
index 0edd86070..207ad40f6 100644
--- a/desktop-app/ui/src/pages/OnboardingPage/types.ts
+++ b/desktop-app/ui/src/pages/OnboardingPage/types.ts
@@ -1,5 +1,5 @@
/**
- * First-run onboarding types (spec §5.2).
+ * First-run onboarding types.
*
* The wizard is one page with a step model and an explicit history stack, not
* a set of routes. Answers live in the controller; only a path's terminal
diff --git a/desktop-app/ui/src/pages/__tests__/AuthPage.test.tsx b/desktop-app/ui/src/pages/__tests__/AuthPage.test.tsx
index 0481394ce..cb1b3883a 100644
--- a/desktop-app/ui/src/pages/__tests__/AuthPage.test.tsx
+++ b/desktop-app/ui/src/pages/__tests__/AuthPage.test.tsx
@@ -87,7 +87,7 @@ function renderAuthPage(auth?: Partial<AuthContextValue>) {
}
describe('AuthPage', () => {
- // The invitation email form moved to onboarding's invited step (spec §5.5).
+ // The invitation email form moved to onboarding's invited step.
// AuthPage has one mode again, and must keep it even if it is somehow
// rendered without an environment — the unauthenticated branch routes that
// case to OnboardingPage instead.
diff --git a/desktop-app/ui/src/pages/__tests__/OnboardingPage.test.tsx b/desktop-app/ui/src/pages/__tests__/OnboardingPage.test.tsx
index 8d8158e84..bb3a731c6 100644
--- a/desktop-app/ui/src/pages/__tests__/OnboardingPage.test.tsx
+++ b/desktop-app/ui/src/pages/__tests__/OnboardingPage.test.tsx
@@ -216,7 +216,7 @@ describe('OnboardingPage', () => {
await user.click(screen.getByRole('button', { name: 'See hosted Evenfire' }))
expect(openHostedSignup).toHaveBeenCalledTimes(1)
- // No argument: the renderer never names a URL for the main process (spec §6.8).
+ // No argument: the renderer never names a URL for the main process.
expect(openHostedSignup).toHaveBeenCalledWith()
expect(handleSaveRuntimeConfig).not.toHaveBeenCalled()
@@ -233,7 +233,7 @@ describe('OnboardingPage', () => {
const step = screen.getByText('Run Evenfire yourself').closest('section')
const copy = step?.textContent || ''
- // Self-hosting means any cluster the user controls (spec §5.4). No install
+ // Self-hosting means any cluster the user controls. No install
// command, no RAM figure, no loopback default, no single deployment shape.
expect(copy).not.toMatch(/minikube|docker|127\.0\.0\.1|localhost|GB|RAM|your machine/i)
})
@@ -248,7 +248,7 @@ describe('OnboardingPage', () => {
await user.click(screen.getByRole('button', { name: 'Open the deployment guide' }))
expect(openDeploymentDocs).toHaveBeenCalledTimes(1)
- // No argument: the renderer never names a URL for the main process (spec §6.8).
+ // No argument: the renderer never names a URL for the main process.
expect(openDeploymentDocs).toHaveBeenCalledWith()
expect(handleSaveRuntimeConfig).not.toHaveBeenCalled()
})
@@ -296,7 +296,7 @@ describe('OnboardingPage', () => {
// Presented as a plain option carrying its address, not a callout banner.
const option = await screen.findByRole('button', { name: /Localhost/ })
expect(option.textContent).toContain('http://127.0.0.1:8091')
- // The probe takes no URL argument (spec §5.6).
+ // The probe takes no URL argument.
expect(probeLocalhostReachable).toHaveBeenCalledWith()
await user.click(option)