docs: correct repeat spec hash key name in site docs#151
Merged
Conversation
The scheduler/concepts pages described the repeatable-spec storage as a
single `{chasqui:<queue>}:repeat:specs` hash mapping spec key to spec.
The engine actually writes one hash per spec at
`{chasqui:<queue>}:repeat:spec:<key>` (see repeat_spec_key in
chasquimq/src/redis/keys.rs). Correct the key name and the
single-hash framing across the three live site pages to match the engine
and the reference/wire-format + redis-cluster docs, which were already
correct.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Corrects the repeatable-spec Redis key name in three live docs-site pages.
The scheduler/concepts pages described the spec storage as a single
{chasqui:<queue>}:repeat:specshash "mapping spec key → encoded spec". The engine actually writes one hash per spec at{chasqui:<queue>}:repeat:spec:<key>(singularspec, keyed by the spec key) — seerepeat_spec_keyinchasquimq/src/redis/keys.rs:58.Why
The
:repeat:specs(single-hash) wording is left over from the original Phase-3 design and was never how the shipped engine works. The reference docs (reference/wire-format.md,concepts/redis-cluster.md) and engine docs already used the correct:repeat:spec:<key>form, so the three pages fixed here were the only stale surfaces. This corrects both the key name and the inaccurate "single hash mapping key → spec" framing.Files
site/src/content/docs/guides/schedule-repeatable-jobs.mdxsite/src/content/docs/concepts/the-scheduler.mdsite/src/content/docs/concepts/thinking-in-chasquimq.mdx(2 occurrences)docs/phase3-napi-design.mdis intentionally left unchanged — it is a frozen historical design artifact describing the planned design, not current behavior.Docs-only, no code or behavior change.