Skip to content

docs(Quick start): Include the api argument in flagsmith.init examples - #8830

Open
linear-code[bot] wants to merge 1 commit into
mainfrom
linear/docs-10-the-flagsmithinit-command-in-the-quickstart-guide-409c
Open

linear-code[bot] wants to merge 1 commit into
mainfrom
linear/docs-10-the-flagsmithinit-command-in-the-quickstart-guide-409c

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

Closes DOCS-10

The quick start's flagsmith.init snippets only work against SaaS, so self-hosted and private cloud users had no hint that they need to set api.

  • Each flagsmith.init example in the quick start now has a commented-out api option, marked as only for self-hosted or private cloud users

Review effort: 1/5

How did you test this code?

  • make install build in docs/ passes. It reports two broken anchors, both on unrelated pages and already present on main.
  • Ran prettier 3.4.2, the version pinned in pre-commit. The file already fails the check on main, and this change adds no new issues.

…mples

Generated with [Linear](https://linear.app/flagsmith/agent-session/e4d63e69-45ea-44cd-b137-b6c60bb763ee)

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:56
@linear-code linear-code Bot added the docs Documentation updates label Oct 21, 2026
@linear-code
linear-code Bot requested review from bakirFS and removed request for a team October 21, 2026 15:56
</script>
```

Now when the browser opens the web page, it will download the Javascript SDK and make a call to `edge.api.flagsmith.com`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I expect this paragraph to account for a custom api parameter in the SDK init.

@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: 1762440e-d3a7-4560-932b-60686b37c799

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.

@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 4:09pm UTC
2 Skipped Deployments
Project Deployment Actions Updated
flagsmith-frontend-preview Ignored Ignored Preview Oct 21, 2026 4:09pm UTC
flagsmith-frontend-staging Ignored Ignored Preview Oct 21, 2026 4:09pm UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview – docs — c1a1e64a 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 linear-loop

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant