docs: fix outdated compatibility matrix and stale references#279
Merged
Conversation
compatibility.md was severely out of date — 30+ commands added in phase 8 were still marked as unsupported (lists, sets, sorted sets, key lifecycle, server/client, transactions). rewrote the full matrix against the actual Command enum. also added an ACL section that was missing entirely. other fixes: - README: update feature lists with phase 8 commands (GETRANGE, SETRANGE, LINDEX, LSET, LTRIM, LINSERT, LREM, LPOS, ZINCRBY, ZREVRANK, ZREVRANGE, ZRANGEBYSCORE, ZCOUNT, ZPOPMIN, ZPOPMAX, SUNION, SINTER, SDIFF, SRANDMEMBER, SPOP, COPY, TOUCH, etc.) - ARCHITECTURE.md: update command count from 114 to 135+ - migration-from-redis.md: fix prometheus metric names (ember_commands_duration_seconds, ember_connections_active) - CONTRIBUTING.md: remove stale "(wip)" from cluster description
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
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.
summary
Commandenum. 30+ commands added in phase 8 were still marked as✗(unsupported) when they're fully implemented — lists (LINDEX, LSET, LTRIM, LINSERT, LREM, LPOS), sets (SUNION, SINTER, SDIFF, SRANDMEMBER, SPOP, SMISMEMBER, SSCAN, and all *STORE variants), sorted sets (ZINCRBY, ZREVRANK, ZREVRANGE, ZRANGEBYSCORE, ZREVRANGEBYSCORE, ZCOUNT, ZPOPMIN, ZPOPMAX, ZSCAN), key lifecycle (COPY, TOUCH, RANDOMKEY, SORT, OBJECT), server (TIME, LASTSAVE, ROLE, MONITOR, CONFIG REWRITE, CLIENT ID/SETNAME/GETNAME/LIST), and transactions (WATCH, UNWATCH). also added a missing ACL section and removed the stale multi/exec entry from "commands out of scope."ember_commands_duration_secondsnotember_command_duration_seconds,ember_connections_activenotember_connected_clients).what was tested
Commandenum incrates/ember-protocol/src/command/mod.rscrates/ember-server/src/metrics.rsdesign considerations
compatibility.md was the worst offender — it actively undersells the project by telling users that 30+ implemented commands don't exist. this is the single most impactful doc fix for adoption since it's what people check when evaluating a Redis alternative.