Skip to content

docs: fix createdAt.maxNegativeDelta key name in CONFIGURATION.md#678

Open
Priyanshubhartistm wants to merge 1 commit into
cameri:mainfrom
Priyanshubhartistm:docs/fix-created-at-negative-delta-key-name
Open

docs: fix createdAt.maxNegativeDelta key name in CONFIGURATION.md#678
Priyanshubhartistm wants to merge 1 commit into
cameri:mainfrom
Priyanshubhartistm:docs/fix-created-at-negative-delta-key-name

Conversation

@Priyanshubhartistm

@Priyanshubhartistm Priyanshubhartistm commented Jul 12, 2026

Copy link
Copy Markdown
Collaborator

Description

CONFIGURATION.md documented the setting as limits.event.createdAt.minNegativeDelta, but the actual key read by the code (and shipped in resources/default-settings.yaml) is maxNegativeDelta. Corrected the key name and reordered the row to keep the settings table alphabetically sorted, per the convention stated at the top of the table ("Please keep this table sorted when adding new entries").

Related Issue

Fixes #677

Motivation and Context

An operator who copies the documented key name (minNegativeDelta) into their settings.yaml gets silent no-op behavior, because the relay never reads that key — only maxNegativeDelta has any effect. This fixes the doc so it matches resources/default-settings.yaml, src/handlers/event-message-handler.ts, and src/app/static-mirroring-worker.ts, all of which use maxNegativeDelta.

How Has This Been Tested?

This is a documentation-only change with no production source touched. Verified:

  • grep -rn "minNegativeDelta" across the codebase shows no other references (docs, tests, or source) needing the same fix.
  • `pnpm exec commitlint --from=upstream/main
  • pnpm exec changeset status --since upstream/main passes (empty changeset, no version bump).
  • Per .github/workflows/checks.yml's paths-filter, CONFIGURATION.md doesn't match the src filter, so lint/build-check/unit/integration test jobs won't run for this PR.

Screenshots (if appropriate):

N/A — documentation-only change.

Types of changes

  • Non-functional change (docs, style, mi
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that wlity to change)

Checklist:

  • My code follows the code style of this
  • My change requires a change to the documentation.
  • I have updated the documentation accor
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my code changes.
  • I added a changeset, or this is docs-ogeset.
  • All new and existing tests passed.

@changeset-bot

changeset-bot Bot commented Jul 12, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: d471633

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] CONFIGURATION.md documents limits.event.createdAt.minNegativeDelta but the real setting is maxNegativeDelta

1 participant