Skip to content

docs: Show the api option for self-hosted users in the quick start - #8829

Closed
linear-code[bot] wants to merge 1 commit into
mainfrom
linear/docs-9-the-flagsmithinit-command-in-the-quickstart-guide-cdcc
Closed

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

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

The quick start's flagsmith.init examples only worked for SaaS users. This adds a commented-out api option to each example, with a comment saying it is only for self-hosted or private cloud users. Step 3 also gets a short paragraph explaining when to uncomment it, and that the URL needs the /api/v1/ suffix. The placeholder URL is the same one used in the experimentation docs.

How did you test this code?

Ran prettier@3.3.3 (the pinned version) on the changed lines. The file already failed the prettier check on main, so I left the lines I didn't touch alone rather than reformat the whole page.

Generated with [Linear](https://linear.app/flagsmith/agent-session/f3c7c3c0-19d3-4aca-91c5-377fdd175cda)

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:42
@linear-code
linear-code Bot requested review from Holmus and removed request for a team October 21, 2026 15:42
@github-actions github-actions Bot added the docs Documentation updates label Oct 21, 2026

@emyller emyller left a comment

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.

sloppy

Comment on lines +97 to +100
If you are using the SaaS platform at [app.flagsmith.com](https://app.flagsmith.com/), you can leave the `api` option
commented out, as the SDK connects to Flagsmith's SaaS API by default. If you are self-hosting Flagsmith or using a
private cloud, uncomment it and replace the URL with your own Flagsmith API URL, including the `/api/v1/` suffix.

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.

This paragraph is slop.

@emyller emyller closed this Oct 21, 2026
@emyller
emyller deleted the linear/docs-9-the-flagsmithinit-command-in-the-quickstart-guide-cdcc branch October 21, 2026 15:48
@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:53pm UTC
2 Skipped Deployments
Project Deployment Actions Updated
flagsmith-frontend-preview Ignored Ignored Oct 21, 2026 3:53pm UTC
flagsmith-frontend-staging Ignored Ignored Oct 21, 2026 3:53pm 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: 6676f1e1-b869-4329-8c63-cbc33e0af593

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 — be2e03f8 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