Skip to content

Conversation

@marciw
Copy link
Contributor

@marciw marciw commented Oct 29, 2025

👁️ Preview docs/reference/index.md

Summary of changes

  • Revised the "Major version upgrades" section in response to https://github.com/elastic/docs-content-internal/issues/421
  • Clarified forward compatibility
  • Added phrasing and table from .NET docs + made the table more accessible
  • Added links to related docs
  • Did a general edit for clarity, concision, Elastic style

❗ Notes for reviewers

TODO

@github-actions
Copy link

github-actions bot commented Oct 29, 2025

🔍 Preview links for changed docs

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the Python client documentation to improve clarity, structure, and accuracy. The changes modernize the content with better explanations of compatibility, feature descriptions, and client usage.

  • Added navigation metadata and improved page title
  • Updated compatibility section with a clearer table and explanations
  • Reorganized content flow with better placement of examples and tips

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@marciw marciw marked this pull request as ready for review October 30, 2025 23:51
@marciw marciw changed the title [WIP] [DOCS] Clarify upgrades and edit generally [DOCS] Clarify upgrades and edit generally Oct 30, 2025
@miguelgrinberg
Copy link
Contributor

@marciw The lint failure is unrelated, I'll fix that separately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants