docs: add deployer OTel SDK setup note to README

[wiggitywhitney]

Description

What does this PR do?

Adds a "Deployer SDK Setup" subsection to the Telemetry Schema section of the README, explaining that commit-story ships with @opentelemetry/api only (a lightweight no-op peerDep), that no OTel SDK is bundled, and that examples/instrumentation.js is provided as a starting-point bootstrap for deployers who want trace data.

Why is this change needed?

Without documentation, deployers have no way to discover that examples/instrumentation.js exists or understand the SDK-is-the-deployer's-choice contract. The code changes (@opentelemetry/sdk-node moved to devDependencies, src/instrumentation.js relocated to examples/) were already in place — this is the final piece.

Related Issues

Addresses spinybacked-orbweaver-eval#23.

Type of Change

• 📚 Documentation update

Testing Checklist

• Manual testing performed

Test results: README renders correctly. No code behavior changed — documentation only.

Security Checklist

• No secrets or credentials committed

Breaking Changes

• No

Additional Context

Reviewer Notes: The package.json and file changes this documents were made in earlier commits — @opentelemetry/sdk-node is already only in devDependencies, and instrumentation.js already lives at examples/. This PR closes the documentation gap.

Summary by CodeRabbit

• Documentation
  • Added a "Deployer SDK Setup" section explaining that the project uses the OpenTelemetry API as a peer dependency and that deployers must provide their own SDK. It describes how to load an instrumentation bootstrap before app startup, shows an example OTLP HTTP exporter and SimpleSpanProcessor configuration, and documents graceful shutdown handling for SIGTERM, SIGINT, and process exit.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4b372b3d-cac3-4337-8a50-1fba3d8fe3d1

📥 Commits

Reviewing files that changed from the base of the PR and between 86e9c05 and b011951.

📒 Files selected for processing (1)

• README.md

✅ Files skipped from review due to trivial changes (1)

• README.md

---

📝 Walkthrough

Walkthrough

This PR updates README.md with a new "Deployer SDK Setup" section documenting that commit-story relies on @opentelemetry/api as a peer dependency and points deployers to examples/instrumentation.js plus a node --import bootstrap approach for instrumentation and graceful shutdown.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added "Deployer SDK Setup" section describing that commit-story uses @opentelemetry/api as a peer dependency, instructing deployers to provide an OTel SDK, referencing examples/instrumentation.js for a bootstrap using OTLP HTTP exporter, SimpleSpanProcessor, and graceful shutdown handling (SIGTERM, SIGINT, process.exit()).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 I nibble lines and tidy docs with care,
A tiny bootstrap seed I leave there—
Peer API noted, traces left to send,
Hop on with Node, let instrumentations blend. 🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title clearly and concisely describes the main change: adding documentation about OpenTelemetry SDK setup requirements for deployers to the README.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feature/fix-23-otel-deployer-setup

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 175-177: The README shows using the Node CLI flag `--import` which
requires Node >=18.18.0, but package.json currently declares "engines": {"node":
">=18.0.0"} — update the package.json `engines.node` value to ">=18.18.0" (or
alternatively add a short note in the README next to the example explaining the
Node >=18.18.0 requirement) so the declared engine requirement matches the
`--import` dependency; target the `engines` entry in package.json (or the README
example text) when making the change.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e40d6f2d-349f-48ca-a3e9-8b67d87a9e79

📥 Commits

Reviewing files that changed from the base of the PR and between 4221212 and 86e9c05.

📒 Files selected for processing (1)

• README.md