Skip to content

docs: Add stale flag detection documentation - #8142

Open
matthewelwell wants to merge 1 commit into
mainfrom
docs/stale-flags
Open

docs: Add stale flag detection documentation#8142
matthewelwell wants to merge 1 commit into
mainfrom
docs/stale-flags

Conversation

@matthewelwell

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 #6016
Closes #7362

Adds a new "Stale Flag Detection" page under Managing Flags covering what makes a feature stale, the plan and Feature Versioning requirements, how to configure the threshold, and how to exclude flags via a permanent tag. Cross-links added from Flag Lifecycle, Tagging, and Code References.

How did you test this code?

Ran npx prettier --check on the touched files. Cross-checked every claim on the page against the code in flagsmith-private/src/workflows_logic/stale_flags/.

@matthewelwell
matthewelwell requested a review from a team as a code owner July 28, 2026 17:10
@matthewelwell
matthewelwell requested review from Holmus and removed request for a team July 28, 2026 17:10
@vercel

vercel Bot commented Jul 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 28, 2026 5:10pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
flagsmith-frontend-preview Ignored Ignored Jul 28, 2026 5:10pm
flagsmith-frontend-staging Ignored Ignored Jul 28, 2026 5:10pm

Request Review

@coderabbitai

coderabbitai Bot commented Jul 28, 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: ASSERTIVE

Plan: Pro Plus

Run ID: 6e3053a0-870f-467a-9132-7e4d927be2e1

📥 Commits

Reviewing files that changed from the base of the PR and between ec9fd4a and 74ccc16.

⛔ Files ignored due to path filters (1)
  • docs/static/img/managing-flags/stale-flags/flag-list-stale.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • docs/docs/best-practices/flag-lifecycle.md
  • docs/docs/managing-flags/code-references.md
  • docs/docs/managing-flags/stale-flags.md
  • docs/docs/managing-flags/tagging.md

📝 Walkthrough

Walkthrough

Added a new Stale Flag Detection documentation page covering detection rules, configuration, system tags, plan requirements, permanent-tag exclusions, and cleanup workflow. Existing flag lifecycle and code-reference documentation now links to it, and tagging guidance clarifies that permanent tags exclude flags from stale detection.

Estimated code review effort: 2 (Simple) | ~10 minutes


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.

@github-actions github-actions Bot added the docs Documentation updates label Jul 28, 2026
@matthewelwell
matthewelwell removed the request for review from Holmus July 28, 2026 17:32

@adamvialpando adamvialpando 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.

Overall I like the docs additions and changes. My only question is with the flag lifecycle additions placement.


Short lived flags are typically used for the following use-scenarios:

Flagsmith can automatically flag features that have not been changed for a configurable period of time — see [Stale Flag Detection](/managing-flags/stale-flags).

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.

I like the reference but it feels out of place right here. Would it make more sense to place it above line 25?

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.

docs: Document stale flag detection (stale_flags_limit_days) docs: add missing content on stale flags

3 participants