docs: add root README/CONTRIBUTING and improve package docs#286
docs: add root README/CONTRIBUTING and improve package docs#286brandon-pereira wants to merge 1 commit into
Conversation
Add a monorepo landing README and contributor guide, fill in the three empty/stub package READMEs, correct the CLI sourcemap command and flags, and standardize headers, license footers, and code fences across packages.
|
Greptile SummaryThis PR adds and refreshes documentation across the JavaScript SDK monorepo. The main changes are:
Confidence Score: 4/5The documented CLI script and clean-environment build path need fixes before merging.
packages/cli/README.md and CONTRIBUTING.md Important Files Changed
Reviews (1): Last reviewed commit: "docs: add root README/CONTRIBUTING and i..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| { | ||
| "scripts": { | ||
| "upload-sourcemaps": "npx @hyperdx/cli upload-sourcemaps --path=\"/path/to/sourcemaps\"" | ||
| "upload-sourcemaps": "hyperdx upload-sourcemaps --path ./dist" |
There was a problem hiding this comment.
Installing @hyperdx/cli with its string-valued bin field creates a cli executable, not hyperdx. A contributor who copies this npm script will receive hyperdx: command not found; invoke the package through npx or add an explicit hyperdx bin mapping.
| "upload-sourcemaps": "hyperdx upload-sourcemaps --path ./dist" | |
| "upload-sourcemaps": "npx @hyperdx/cli upload-sourcemaps --path ./dist" |
| order between packages. | ||
| - **[Changesets](https://github.com/changesets/changesets)** manages versioning | ||
| and publishing. | ||
| - Node **v25** is recommended (see `.nvmrc`). |
There was a problem hiding this comment.
The setup guide lists only Node before instructing contributors to run yarn ci:build, but that command builds @hyperdx/deno through deno run -A build-npm.ts. A clean environment following these steps stops with deno: command not found; document Deno as a prerequisite, as the CI workflows install it before building.
| - Node **v25** is recommended (see `.nvmrc`). | |
| - Node **v25** is recommended (see `.nvmrc`). | |
| - **Deno** is required to build the `@hyperdx/deno` workspace. |
Context Used: AGENTS.md (source)
1 participant
Summary
The repo had no landing page and no contributor guide, three published packages shipped with empty or single-line READMEs (so their npm pages were blank), and the CLI README documented a command that doesn't exist. This adds the missing top-level docs and brings every package README up to a consistent baseline.
What changed
README.md(new) — monorepo landing page: a table of all 9 packages linking to their npm pages and READMEs, docs links, and a Development section using the real root scripts.CONTRIBUTING.md(new) — contributor guide covering repo layout, the Nx/Changesets workflow, single-package build/test commands, and a fork-based PR flow. Defers toAGENTS.mdfor detailed style rules rather than duplicating them.instrumentation-exception(was 0 bytes),otel-web, andsession-recorder(were title-only) now have an install command and a pointer to the package that consumes them (@hyperdx/browser/@hyperdx/node-opentelemetry). Kept minimal since these are internally consumed rather than direct-use APIs.uploadcommand is actuallyupload-sourcemaps; added a full flag table (verified againstpackages/cli/src/index.ts),HYPERDX_SERVICE_KEYusage, and a self-hosted example.***HYPERDX_API_KEY***placeholders innode-loggerwithprocess.env.HYPERDX_API_KEYand tagged its code fences; fixed theinstrumentation-sentry-nodenpm badge (pointed atinstrumentation-pg) and license link; added a title/description header and license footers across packages that lacked them.Test plan
Docs-only change. Ran Prettier over all touched Markdown files to conform to the repo's formatting hook.