Skip to content

chore: restructure Node Js SDK doc to match template#82

Open
dharmadeveloper108 wants to merge 3 commits into
mainfrom
revamp-node-sdk-docs
Open

chore: restructure Node Js SDK doc to match template#82
dharmadeveloper108 wants to merge 3 commits into
mainfrom
revamp-node-sdk-docs

Conversation

@dharmadeveloper108
Copy link
Copy Markdown
Contributor

Restructures the Node.js SDK page to follow the SDK doc template (same structure as the Go SDK):

  • Replaces bullet-list config options with components
  • Adds missing config options verified against source (backupPath, projectName, bootstrapOverride, disableAutoStart, skipInstanceCountWarning, metricsJitter)
  • Fixes tags type from {type, value} to {name, value} (matches TagFilter interface)
  • Updates minimum Node.js version from 18 to 20 (matches package.json)
  • Fixes initialize singleton description (returns existing instance or throws, does not replace)
  • Restructures Impact metrics section to use shared snippet + tabs (matching Go SDK)
  • Adds shared snippets (backend-intro, backend-singleton-warning, backend-connection, impact-metrics, impression-data-intro)
  • Added Requirements, Impression data, and Troubleshooting sections

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 8, 2026

🌿 Preview your docs: https://unleash-preview-revamp-node-sdk-docs.docs.buildwithfern.com

Here are the markdown pages you've updated:

</Tab>
<Tab title="Histogram">

Use histograms to measure the distribution of values, such as request duration or response size. Unleash automatically calculates percentiles (p50, p95, p99).
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The line about percentiles is not in the Go SDK doc, is it correct to drop it?

</Tab>
</Tabs>

## Flag definitions
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph was moved further down

unleash.on('error', console.error);
```

### Synchronous initialization
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this paragraph was merged into "Wait until the SDK is ready"

@dharmadeveloper108 dharmadeveloper108 marked this pull request as ready for review April 8, 2026 13:58
@melindafekete melindafekete self-assigned this Apr 8, 2026
dharmadeveloper108 added a commit to Unleash/unleash-node-sdk that referenced this pull request Apr 9, 2026
- Replaces the full usage documentation in README with a minimal version following the same pattern as the [Go SDK README](https://github.com/Unleash/unleash-go-sdk)
- Removes some of the documentation that now (when the [PR](Unleash/unleash-documentation#82) is merged) lives in the [docs site](https://docs.getunleash.io/sdks/node) 
- Makes README focus on: quick start, requirements, and contributing (local dev, tests, benchmarking, linting, building)
- Removes stale Code Climate badge
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants