[Docs] Misc updates#46728
Open
pvaneck wants to merge 2 commits intoAzure:mainfrom
Open
Conversation
Applied some formatting, cleanup, and updating of various docs. Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR performs a set of documentation cleanups and updates across the repo docs, including reorganizing developer-facing doc entry points, updating release guidance to reflect current ESRP-based publishing, and refreshing Python version support information.
Changes:
- Reorganized
doc/dev/README.mdinto clearer sections (getting started, testing, quality, troubleshooting, generation, AI, conda) and updated various links. - Updated release documentation to reflect Unified Pipelines + ESRP (and removed legacy manual
twineupload guidance). - Refreshed version/support and misc doc fixes (Python version support table split, typo fixes, link migrations to learn.microsoft.com, removal of outdated engineering assumptions doc).
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/README.md | Adds “SDK and AI” doc link and removes the deleted engineering assumptions link. |
| doc/python_version_support_policy.md | Splits supported vs. EOL Python versions into separate tables for clarity. |
| doc/dev/tests.md | Updates venv example command for alternate Python versions (but introduces an invalid venv -p example). |
| doc/dev/release.md | Updates release guidance to emphasize Azure DevOps + ESRP and removes manual publishing section. |
| doc/dev/README.md | Major restructuring of developer docs index with additional topics and updated links. |
| doc/dev/perfstress_tests.md | Fixes async client typos and updates perf test environment guidance (includes a new “Start be” typo). |
| doc/dev/issues/resolve_issues_effectively.md | Minor cleanup and removes outdated troubleshooting guidance. |
| doc/dev/find_sdk/find_sdk_in_cli_command.md | Heading cleanup and updates a docs.microsoft.com link to learn.microsoft.com. |
| doc/dev/engineering_assumptions.md | Removes an outdated engineering assumptions document. |
| doc/dev/dev_setup.md | Adds uv workflow option and revises environment setup wording (activation commands need correction). |
| doc/dev/code_snippets.md | Fixes sample filename references and minor formatting cleanup. |
xiangyan99
approved these changes
May 5, 2026
kashifkhan
reviewed
May 6, 2026
| .\env\Scripts\activate.bat # Windows CMD | ||
| ``` | ||
|
|
||
| Alternatively, you can use [uv][uv] which is faster and handles Python version management automatically: |
kashifkhan
reviewed
May 6, 2026
| # Running the tests | ||
| In order to run the performance tests, the `devtools_testutils` package must be installed. This is done as part of the `dev_requirements`. | ||
| Start be creating a new virtual environment for your perf tests. This will need to be a Python 3 environment, preferably >=3.7. | ||
| Start by creating a new virtual environment for your perf tests. This will need to be a Python 3 environment. |
Member
There was a problem hiding this comment.
maybe a link out to the min supported version would work here?
kashifkhan
reviewed
May 6, 2026
| | 3.14 ([PEP 745](https://www.python.org/dev/peps/pep-0745/#lifespan)) | October 2030 | April 30, 2031 | | ||
| | 3.15 ([PEP 790](https://www.python.org/dev/peps/pep-0790/#lifespan)) | October 2031 | April 30, 2032 | | ||
|
|
||
| ## End-of-life versions (no longer supported) |
Member
There was a problem hiding this comment.
how about we remove this section entirely ? They arent supported and only versions present are.
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.
Applied some formatting, cleanup, and updating of various docs.