Skip to content

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

Closed
emyller wants to merge 2 commits into
mainfrom
emyller/docs-3-the-flagsmithinit-command-in-the-quickstart-guide-5004
Closed

emyller wants to merge 2 commits into
mainfrom
emyller/docs-3-the-flagsmithinit-command-in-the-quickstart-guide-5004

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-3

The quickstart's flagsmith.init snippets left out the api option, so self-hosted and private cloud users had no hint that they need to set it. This change adds it, commented out, with a one-line note saying who needs it. It goes in all three snippets on the page so that the full example people copy matches. The placeholder URL matches the existing example in the experimentation docs and follows the JS SDK's …/api/v1/ format.

How did you test this code?

Ran npm run build in docs/ (the same check as the Docs Lint/Link Checks CI). Prettier --check still reports this file, but only for prose wrapping that is already on main. None of the warnings are in the lines this PR changes.

Generated with [Linear](https://linear.app/flagsmith/agent-session/231d6787-9ed9-4422-a687-83853d3bd04e)

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
…comment

Generated with [Linear](https://linear.app/flagsmith/agent-session/231d6787-9ed9-4422-a687-83853d3bd04e)

Co-authored-by: linear-code[bot] <222613912+linear-code[bot]@users.noreply.github.com>
@linear-code linear-code Bot changed the title docs: Show the api option for self-hosted users in the quickstart docs(Quick start): The flagsmith.init command in the quickstart guide should include the api argument 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:42pm UTC
2 Skipped Deployments
Project Deployment Actions Updated
flagsmith-frontend-preview Ignored Ignored Preview Oct 21, 2026 2:42pm UTC
flagsmith-frontend-staging Ignored Ignored Preview Oct 21, 2026 2:42pm 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 — bbdcb25f 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