[DOCS] Improve number_of_shards option page #1780
Draft
Conversation
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
Updated documentation for the number_of_shards option, clarifying its purpose and criteria for usage. Changes include: - Moved description to top - Explicitly stated type, default, and whether it’s optional. - Added links to shards intro and shard sizing guidance to help with assumed knowledge. - Clarified scope: relevant to cloud/on-prem, not serverless.
There was a problem hiding this comment.
Pull Request Overview
Improves the documentation for the number_of_shards option by reorganizing content for better clarity and adding essential context for users. The update moves the description to the top, specifies metadata like type and default value, and provides educational links about shards.
- Reorganized content structure with description moved to the top for immediate clarity
- Added explicit metadata including type (Integer), default value (1), and requirement status (Optional)
- Enhanced with educational links to sharding concepts and sizing guidance
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
🔍 Preview links for changed docs |
KOTungseth
commented
Sep 17, 2025
KOTungseth
commented
Sep 17, 2025
KOTungseth
commented
Sep 17, 2025
KOTungseth
commented
Sep 17, 2025
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.
Updated documentation for the number_of_shards option, clarifying its purpose and criteria for usage.
Changes include: