chore: pre-public polish (docs, sample host, NOTICE, drop unused test.proto) - #12
Merged
Merged
Conversation
….proto) Final cleanup before the repo goes public. No functional changes to the bridge. - Docs: correct the Node baseline from 20+ to 22+ (matches engines.node and the CI matrix after dropping EOL Node 20) in the deployment runbook, the testing runbook (prose plus the Step 1 preflight check), and the contributing guide. - Docs: reconcile the Messages tab with the manifest. manifest.json sets messages_tab_enabled:false (Home tab only), so the README and deployment runbook no longer claim the Messages tab is enabled. - Sample data: use the reserved telemetry.example.io instead of the real registrable telemetry.vendor.io in send-samples and sample-events. - proto/NOTICE: quote NVIDIA's SPDX header in its actual order (SPDX-FileCopyrightText then SPDX-License-Identifier). - Remove proto/test.proto: an unused upstream persistence-test fixture the bridge never loads (it loads openshell.proto and its imports only). Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Final polish before this sample goes public. No functional changes to the bridge; docs, sample-data, and licensing hygiene plus removal of one unused proto.
Changes
Docs: Node baseline (correctness). After EOL Node 20 was dropped in the dependency upgrade (
engines.nodeis>=22; CI tests 22.x/24.x), several docs still said "Node 20+". Corrected to 22+ in:docs/03-deployment.md(Prerequisites)docs/04-testing-runbook.md(Host assumptions, and the Step 1 preflightnode -pcheck that green-lit Node 20 before the app rejected it).github/contributing.md(Development setup)Docs: Messages tab (consistency).
manifest.jsonsetsmessages_tab_enabled: false(Home tab only). The README and deployment runbook claimed the Messages tab was enabled; corrected to match the manifest.Sample data.
telemetry.vendor.iois a real registrable domain; replaced with the reservedtelemetry.example.ioinscripts/send-samples.tsandsrc/capture/sample-events.ts, matching the surrounding.examplesample hosts.proto/NOTICE. Quote NVIDIA's SPDX header in its real order (
SPDX-FileCopyrightTextthenSPDX-License-Identifier).Remove
proto/test.proto. An unused upstream persistence-test fixture. The client loadsopenshell.protoand its imports (datamodel/options/sandbox) only; nothing referencestest.proto.Verification
npm run typecheck— cleannpm test— 202 / 202 passnpm run build— cleanCo-Authored-By: Claude svc-devxp-claude@slack-corp.com