[docs] docs: reduce bloat in data-ops.md#20437
Merged
Conversation
Remove structural redundancy between intro and "Separation of Concerns" section, simplify verbose example agent prompt, and condense "Best Practices" into a compact bullet list. Reduces file from 249 to 188 lines while preserving all essential information. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
github-actions
bot
added
automation
documentation
pelikhan
approved these changes
Mar 11, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Reduces verbosity in the DataOps documentation by consolidating redundant explanations, shortening an example agent prompt, and tightening best-practice guidance.
Changes:
- Condensed the intro/“when to use” guidance into a single, more compact opening paragraph.
- Simplified the PR Activity Summary example prompt to a shorter, more realistic instruction set.
- Rewrote “Best Practices” as a concise bullet list.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+116
to
117
| Create a discussion summarizing: total PRs, merge rate, code changes (+/- lines), top contributors, and any notable trends. Keep it concise and factual. | ||
| ```` |
There was a problem hiding this comment.
The Weekly PR Summary example still uses a 4-backtick fence (aw wrap … ) but it no longer contains nested triple-backtick blocks. Consider switching to a standard 3-backtick fence for consistency with the other examples in this doc and to avoid confusing future edits.
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.
Reduces documentation bloat in
docs/src/content/docs/patterns/data-ops.mdby 24% (249 → 188 lines, -61 lines).File Improved
docs/src/content/docs/patterns/data-ops.mdTypes of Bloat Removed
Structural redundancy — The intro paragraph and the "Separation of Concerns" subsection described the same two-phase concept in nearly identical language. Merged into a single concise opening sentence that incorporates the "When to Use" use-cases inline (-17 lines).
Verbose example agent prompt — The PR Activity Summary example had a four-section agent prompt (
## Available Data,## Your Taskwith nested bullet lists, and## Report Formatwith a full markdown output template). Replaced with a concise, realistic prompt that demonstrates good practice without over-engineering (-30 lines).Padded Best Practices — Five verbose bold-paragraph items rewritten as a tight bullet list with no information loss (-7 lines).
Changes Summary
Screenshots
Screenshots could not be captured in this run due to network sandbox restrictions preventing Playwright from accessing the preview server (connection refused to
localhost:4321and timeout for the container network IP). The docs build completed successfully with all internal links valid.References: