Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Rewrite segments doc #3872

Merged
merged 3 commits into from May 6, 2024
Merged

docs: Rewrite segments doc #3872

merged 3 commits into from May 6, 2024

Conversation

rolodato
Copy link
Contributor

@rolodato rolodato commented May 2, 2024

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

  • I have run pre-commit to check linting
  • 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?
  • I have used a Conventional Commit title for this Pull Request

Changes

See c5fa3cc for the main changes and the commit description.

The title of the document was renamed from "Managing Segments" to just "Segments". Eventually we should rename the other documents to follow suit:

  • Managing Features
  • Managing Identities

How did you test this code?

N/A

Copy link

vercel bot commented May 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 3, 2024 6:33pm
flagsmith-frontend-preview ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 3, 2024 6:33pm
flagsmith-frontend-staging ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 3, 2024 6:33pm

Drop the "managing", just "segments". It's cleaner.
* Reorder sections in a better importance order
* Add example use cases to introduction section
* Many grammar/phrasing changes
* Add a security/privacy section high up
* Clarify how multiple segment overrides for a single feature work
* List minimum required SDK versions for local eval in one table
* Clarify what happens with unsupported operators in SDK clients
Copy link
Contributor

github-actions bot commented May 3, 2024

Uffizzi Preview deployment-51208 was deleted.

@rolodato rolodato marked this pull request as ready for review May 3, 2024 13:45
@rolodato rolodato requested review from a team and khvn26 and removed request for a team May 3, 2024 13:45
@rolodato rolodato added this pull request to the merge queue May 6, 2024
Merged via the queue into main with commit 2fe2752 May 6, 2024
22 checks passed
@rolodato rolodato deleted the docs/improve-segments-doc branch May 6, 2024 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs front-end Issue related to the React Front End Dashboard
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants