Add feature flags guide to docs #26

New issue

Closed

opened 2026-06-07 17:21:25 +00:00 by ldraney · 0 comments

ldraney commented

2026-06-07 17:21:25 +00:00

Owner

Type

Feature

Lineage

Standalone — needed as the reference doc for the ### Feature Flag section added to template-issue-feature in pal-e-docs. Agents need a repo-local doc to read before implementing flagged features.

Repo

ldraney/palinks

User Story

As a dev agent
I want a docs/feature-flags.md in the repo
So that I know how to register, gate, and name feature flags before implementing a flagged feature

Context

The template-issue-feature in pal-e-docs now requires a ### Feature Flag section. That section directs agents to read the repo's docs/feature-flags.md. Palinks doesn't have one yet. The feature flag system design exists scattered across docs/architecture.md (data model) and docs/user-stories.md (US-3), but needs a consolidated reference.

File Targets

docs/feature-flags.md — create the guide
README.md — add to TOC

Feature Flag

Flag: none
This is documentation, not a flagged feature.

Acceptance Criteria

docs/feature-flags.md covers flag types, data model, resolution order, how to add a flag
Added to README TOC

Test Expectations

Docs-only — no tests needed

Constraints

Must match the design in docs/architecture.md (FEATURE_FLAGS table, role_overrides, user preferences)

Checklist

PR opened
Tests pass
No unrelated changes

project-palinks
ldraney/palinks #16 — Keycloak spike includes feature flag system

### Type Feature ### Lineage Standalone — needed as the reference doc for the `### Feature Flag` section added to `template-issue-feature` in pal-e-docs. Agents need a repo-local doc to read before implementing flagged features. ### Repo `ldraney/palinks` ### User Story As a dev agent I want a `docs/feature-flags.md` in the repo So that I know how to register, gate, and name feature flags before implementing a flagged feature ### Context The `template-issue-feature` in pal-e-docs now requires a `### Feature Flag` section. That section directs agents to read the repo's `docs/feature-flags.md`. Palinks doesn't have one yet. The feature flag system design exists scattered across `docs/architecture.md` (data model) and `docs/user-stories.md` (US-3), but needs a consolidated reference. ### File Targets - `docs/feature-flags.md` — create the guide - `README.md` — add to TOC ### Feature Flag Flag: none This is documentation, not a flagged feature. ### Acceptance Criteria - [ ] `docs/feature-flags.md` covers flag types, data model, resolution order, how to add a flag - [ ] Added to README TOC ### Test Expectations - [ ] Docs-only — no tests needed ### Constraints - Must match the design in `docs/architecture.md` (FEATURE_FLAGS table, role_overrides, user preferences) ### Checklist - [ ] PR opened - [ ] Tests pass - [ ] No unrelated changes ### Related - `project-palinks` - `ldraney/palinks #16` — Keycloak spike includes feature flag system