[hotfix][docs] Fix typo and heading level in state backends documentation#28173
Open
Dennis-Mircea wants to merge 2 commits into
Open
[hotfix][docs] Fix typo and heading level in state backends documentation#28173Dennis-Mircea wants to merge 2 commits into
Dennis-Mircea wants to merge 2 commits into
Conversation
Collaborator
klion26
reviewed
May 20, 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.
What is the purpose of the change
This pull request fixes two small issues in the user-facing state backends documentation (
docs/content/docs/ops/state/state_backends.md):### Advanced RocksDB Memory Turning→### Advanced RocksDB Memory Tuning. The body of the section uses "tuning" correctly, confirming the heading was a slip.## Available State Backends: the sibling subsections### The HashMapStateBackendand### The EmbeddedRocksDBStateBackendare at level 3, but## The ForStStateBackendwas at level 2, implicitly closing the parent section. Demote it to### The ForStStateBackendso it nests correctly under## Available State Backends.Brief change log
docs/content/docs/ops/state/state_backends.md: rename the heading fromAdvanced RocksDB Memory TurningtoAdvanced RocksDB Memory Tuning.docs/content/docs/ops/state/state_backends.md: change## The ForStStateBackendto### The ForStStateBackendso it sits at the same nesting level as the other backend subsections. Hugo's heading slug is independent of level, so the existing anchor#the-forststatebackend(referenced fromdocs/{,.zh}/ops/state/disaggregated_state.md) continues to resolve.The Chinese mirror under
docs/content.zh/does not carry the affected heading nor the ForStStateBackend subsection, so no parallel edits are needed there.Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation
Was generative AI tooling used to co-author this PR?