Skip to content

docs: remove outdated State Resync Event section#1970

Open
kunalworldwide wants to merge 1 commit into
open-feature:mainfrom
kunalworldwide:fix-1809
Open

docs: remove outdated State Resync Event section#1970
kunalworldwide wants to merge 1 commit into
open-feature:mainfrom
kunalworldwide:fix-1809

Conversation

@kunalworldwide

Copy link
Copy Markdown

Description

Removes the "State Resync Events" section from as it describes behavior that flagd does not actually support.

Context

Issue #1797 clarified that flagd does not handle cases where the same flag key is defined across multiple sources. The removed section incorrectly implied that when a higher-priority source deletes its version of a flag, a resync event would restore the flag definition from a lower-priority source. This is not accurate behavior.

The section being removed included:

  • The "State Resync Events" heading and all its descriptive paragraphs
  • References to flag-merge-3.svg and flag-merge-4.svg diagrams

This is a minimal documentation-only fix with no code changes.

Closes #1809

@kunalworldwide kunalworldwide requested review from a team as code owners May 27, 2026 18:18
@netlify

netlify Bot commented May 27, 2026

Copy link
Copy Markdown

Deploy Preview for polite-licorice-3db33c canceled.

Name Link
🔨 Latest commit c98801f
🔍 Latest deploy log https://app.netlify.com/projects/polite-licorice-3db33c/deploys/6a571b35f84b7f000898b821

@dosubot dosubot Bot added the size:S This PR changes 10-29 lines, ignoring generated files. label May 27, 2026

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request removes the 'State Resync Events' section from the documentation in docs/concepts/syncs.md. I have no feedback to provide as there are no review comments to assess.

@sonarqubecloud

Copy link
Copy Markdown

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 69518526-1316-4e86-9a97-1a20e8f096cc

📥 Commits

Reviewing files that changed from the base of the PR and between 3e6bb17 and c98801f.

📒 Files selected for processing (1)
  • docs/concepts/syncs.md
💤 Files with no reviewable changes (1)
  • docs/concepts/syncs.md

📝 Walkthrough

Walkthrough

The sync concepts documentation removes the outdated State Resync Events section and its related illustrations.

Changes

Sync documentation

Layer / File(s) Summary
Remove outdated resync section
docs/concepts/syncs.md
Deletes the State Resync Events explanation and the associated “flag merge 3” and “flag merge 4” images.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR removes the outdated section, but it does not appear to add the required warning that the same flagset ID must not be used across multiple sources. Add documentation stating that identical flagset IDs must not be defined across multiple sources and note the risks of doing so.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main docs change: removing the outdated State Resync Event section.
Description check ✅ Passed The description matches the documentation-only change and explains why the section was removed.
Out of Scope Changes check ✅ Passed The changes stay within the stated docs cleanup and remove only the outdated section and related images.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

Removes the State Resync Events section from syncs.md as it describes
behavior that flagd does not actually support. Issue open-feature#1797 clarified that
flagd does not handle cases where the same flag key is defined across
multiple sources. The removed section incorrectly implied that a resync
event would restore a flag definition from a lower-priority source when
a higher-priority source deleted its version of the flag.

Closes open-feature#1809

Signed-off-by: Kunal Das <kunalworldwide@gmail.com>
@sonarqubecloud

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Remove outdated Resync Event section for Sync sources

1 participant