[Docs] Refresh unified-store, auth/config, and API docs#1970
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Garnet’s documentation to reflect the current unified single-store architecture, current configuration/authentication options, and up-to-date command/feature documentation across getting-started, developer, commands, cluster, benchmarking, and Azure docs.
Changes:
- Refresh docs to describe the unified store model (string vs object values via
ValueIsObject, updated memory/config/compaction language). - Update extensibility and developer docs to match current APIs/types (
PinnedSpanByte, updatedRegisterApi/module signatures, updated parsing guidance). - Update command/compatibility/benchmarking docs (command lists/anchors, examples targeting
net10.0, assorted wording fixes).
PR title/description review:
- Title
"Update documentation"is too vague for future searchability. Suggested:[Docs] Refresh unified-store, auth/config, and API docs(or similar). - No PR description was provided in metadata; it should briefly call out the unified-store doc refresh + config/auth/extensibility signature updates (and ideally mention any notable doc-accuracy fixes).
Reviewed changes
Copilot reviewed 38 out of 38 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/welcome/roadmap.md | Adjust roadmap items to match current direction and remove outdated entries |
| website/docs/welcome/features.md | Update memory-control bullet wording to reflect heap/object accounting |
| website/docs/welcome/compatibility.md | Fix numbering and update wording (Lua/extensibility/etc.) |
| website/docs/welcome/about-us.md | Update contributors list |
| website/docs/getting-started/security.md | Expand TLS/authentication-mode documentation |
| website/docs/getting-started/memory.md | Rewrite memory model docs for unified store + updated config names |
| website/docs/getting-started/configuration.md | Update redis.conf mapping + configurable settings table |
| website/docs/getting-started/compaction.md | Update segment/compaction text for main-log vs object-log |
| website/docs/getting-started/build.md | Update build prerequisites and Visual Studio guidance |
| website/docs/extensions/transactions.md | Update custom transaction helper/API docs (PinnedSpanByte, signatures, scratch buffer reset) |
| website/docs/extensions/raw-strings.md | Update raw-string extension method signatures (StringInput) and registration signature |
| website/docs/extensions/procedure.md | Update procedure registration signature and scratch-buffer guidance |
| website/docs/extensions/overview.md | Update extension overview wording for unified store model |
| website/docs/extensions/objects.md | Update custom object function signatures to ReadOnlySpan<byte> keys |
| website/docs/extensions/module.md | Update module registration APIs to include RespCommandDocs |
| website/docs/dev/vector-sets.md | Restructure headings and update wording to “store” vs “main store” where appropriate |
| website/docs/dev/tsavorite/reviv.md | Update revivification documentation to reflect current callback naming and behavior |
| website/docs/dev/tsavorite/logrecord.md | Rewrite LogRecord doc for current Tsavorite design and types (PinnedSpanByte, HeapMemorySize) |
| website/docs/dev/tsavorite/locking.md | Update example to use session.TransactionalUnsafeContext property |
| website/docs/dev/transactions.md | Update transaction internals doc to reflect current key-locking/types and callback names |
| website/docs/dev/range-index-resp-api.md | Update range-index RESP/API and parsing guidance text |
| website/docs/dev/processing.md | Update processing-layer wording and current callback naming |
| website/docs/dev/onboarding.md | Fix Tsavorite SpanByte path + update DbScan signature/types and wording |
| website/docs/dev/multi-db.md | Update multi-db manager naming + clarify checkpoint/object-log layout |
| website/docs/dev/garnet-api.md | Update “adding a RESP command” doc to current file paths and parser architecture |
| website/docs/dev/custom-commands.md | Update custom command docs (including config example formatting) |
| website/docs/dev/cluster/migration.md | Update migration doc to reflect unified store scanning/behavior |
| website/docs/commands/vector-sets.md | Update “main store” wording to “store” |
| website/docs/commands/server.md | Update FLUSHANDEVICT wording for unified store |
| website/docs/commands/garnet-specific.md | Update WATCHMS/WATCHOS wording to describe value type rather than store |
| website/docs/commands/data-structures.md | Fix intra-doc anchors/casing in references |
| website/docs/commands/api-compatibility.md | Expand/adjust command list (e.g., SLOWLOG, HELP, SHARDS), fix anchors/links |
| website/docs/cluster/replication.md | Remove object-store-specific replication fields from examples |
| website/docs/cluster/overview.md | Update MOVED example IPs to localhost |
| website/docs/benchmarking/results-resp-bench.md | Update example commands to target net10.0 |
| website/docs/benchmarking/resp-bench.md | Update benchmark examples to target net10.0 and adjust sample args |
| website/docs/azure/overview.md | Update encryption link anchor |
| website/docs/azure/api-compatibility.md | Fix command link names/anchors (e.g., GETKEYSINSLOT) |
Comments suppressed due to low confidence (1)
website/docs/dev/transactions.md:62
- Grammar issues: duplicated "the" and "functions" should be singular "function".
When the the `TxnState` is *Started* and we encounter the `EXEC` we call `TransactionManager.Run()`. What this functions does:
badrishc
force-pushed
the
badrishc/docs-update
branch
2 times, most recently
from
July 23, 2026 00:55
5db86a0 to
9f97dbd
Compare
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 513c86bf-84d2-4521-88c6-c963e28036b0
badrishc
force-pushed
the
badrishc/docs-update
branch
from
July 23, 2026 01:31
9f97dbd to
3f16fb0
Compare
vazois
approved these changes
Jul 23, 2026
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.
No description provided.