Skip to content

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

Closed
emyller wants to merge 2 commits into
mainfrom
emyller/docs-4-the-flagsmithinit-command-in-the-quickstart-guide-1e9f
Closed

emyller wants to merge 2 commits into
mainfrom
emyller/docs-4-the-flagsmithinit-command-in-the-quickstart-guide-1e9f

Conversation

@emyller

@emyller emyller commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

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 https://linear.app/flagsmith/issue/DOCS-4

Self-hosted and private cloud users following the quick start couldn't tell that they need to point the SDK at their own API. The Connect to the Flagsmith API example now includes a commented-out api argument with a one-line note on who should set it. SaaS users can leave it commented out. The text after the example now also mentions that the SDK calls your own API when api is set.

Review effort: 1/5

How did you test this code?

  • make build in docs/ succeeds, and the comment appears in the built quick start page.
  • prettier@3.4.2 (the version pinned in pre-commit) leaves the changed lines untouched. The file already fails Prettier on main for unrelated paragraphs, so I didn't reformat it here.

…t` example

Generated with [Linear](https://linear.app/flagsmith/agent-session/907914e8-c04c-4f4d-8b1b-ccae84bad4f8)

Co-authored-by: linear-code[bot] <222613912+linear-code[bot]@users.noreply.github.com>
@github-actions github-actions Bot added the docs Documentation updates label Oct 21, 2026
Generated with [Linear](https://linear.app/flagsmith/agent-session/907914e8-c04c-4f4d-8b1b-ccae84bad4f8)

Co-authored-by: linear-code[bot] <222613912+linear-code[bot]@users.noreply.github.com>
@emyller emyller changed the title docs: Show the api option in the quick start guide's flagsmith.init example docs(Quick start): Include the api argument in the flagsmith.init example 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 2:57pm UTC
2 Skipped Deployments
Project Deployment Actions Updated
flagsmith-frontend-preview Ignored Ignored Preview Oct 21, 2026 2:57pm UTC
flagsmith-frontend-staging Ignored Ignored Preview Oct 21, 2026 2:57pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Oct 21, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • 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 — c1b69065 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