Skip to content

docs(Quick start): The flagsmith.init command in the quickstart guide should include the api argument - #8824

Closed
linear-code[bot] wants to merge 2 commits into
mainfrom
emyller/docs-5-the-flagsmithinit-command-in-the-quickstart-guide-530d
Closed

linear-code[bot] wants to merge 2 commits into
mainfrom
emyller/docs-5-the-flagsmithinit-command-in-the-quickstart-guide-530d

Conversation

@linear-code

@linear-code linear-code Bot commented Oct 21, 2026

Copy link
Copy Markdown

Thanks for submitting a PR! Please check the boxes below:

  • I have read the Contributing Guide.
  • I have added information to docs/ if required so people know about the feature.
  • I have filled in the "Changes" section below.
  • I have filled in the "How did you test this code" section below.

Changes

Contributes to DOCS-5. Replaces #8822, a closed draft on the same branch.

The quick start's flagsmith.init examples left out api. Without it, self-hosted and private cloud users have no hint that their SDK must point at their own API rather than the default https://edge.api.flagsmith.com/api/v1/.

  • Each flagsmith.init example now includes a commented-out api: 'https://flagsmith.example.com/api/v1/', marked as self-hosted or private cloud only.
  • Step 3 says when to uncomment it, and that the URL ends in /api/v1/.

Review effort: 1/5

How did you test this code?

  • npm ci && npm run build in docs/ succeeds, which is the same check CI runs. All three examples show the line on the built page.
  • I confirmed the option name and default URL against the JS SDK source (flagsmith-core.ts) and the existing JavaScript SDK docs.
  • prettier@3.4.2 --check, as pinned in pre-commit, already flags this file on main and the unchanged lines are the cause. Formatting it would rewrap the whole page and break the :::tip block, so I left that out of this PR.

emyller and others added 2 commits October 21, 2026 14:57
Generated with [Linear](https://linear.app/flagsmith/agent-session/5f9f09ce-0c79-4d96-98c0-ca1e7017ec07)

Co-authored-by: linear-code[bot] <222613912+linear-code[bot]@users.noreply.github.com>
Generated with [Linear](https://linear.app/flagsmith/agent-session/5f9f09ce-0c79-4d96-98c0-ca1e7017ec07)

Co-authored-by: linear-code[bot] <222613912+linear-code[bot]@users.noreply.github.com>
@linear-code
linear-code Bot requested a review from a team as a code owner October 21, 2026 15:12
@linear-code linear-code Bot added the docs Documentation updates label Oct 21, 2026
@linear-code
linear-code Bot requested review from matthewelwell and removed request for a team October 21, 2026 15:12
@linear-code linear-code Bot added the docs Documentation updates label Oct 21, 2026
@emyller emyller closed this Oct 21, 2026
@vercel

vercel Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 21, 2026 3:26pm UTC
2 Skipped Deployments
Project Deployment Actions Updated
flagsmith-frontend-preview Ignored Ignored Preview Oct 21, 2026 3:26pm UTC
flagsmith-frontend-staging Ignored Ignored Preview Oct 21, 2026 3:26pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Oct 21, 2026

Copy link
Copy Markdown

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: b6a6a447-8864-4cf4-946d-f8f3a4d31de1

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

This branch was successfully deployed

1 active deployment
Preview – docs — 9b323bca Deployed Oct 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant