Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[docs] Fix documentation inconsistencies in doc/ folder

Abierto
  • ¿Algo no está bien?
#48,507 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

  • #48561 de @Hashim1999164 — cerrado sin fusionar

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
python
Área
documentation

Línea de trabajo

Revisa los archivos indicados bajo doc/, especialmente doc/dev/tests.md, doc/dev/packaging.md y las guías de management, docstring, request-builder y send-request. Verifica cada URL, nombre de archivo, comando y clasificador de Python referenciados con respecto al repositorio actual y a la documentación pública. La tarea estará terminada cuando los nombres, enlaces y ejemplos de herramientas documentados coincidan con el estado actual del proyecto y no contengan referencias obsoletas o internas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

agentic-workflows automated documentation

Summary

This PR fixes a set of documentation inconsistencies found across the doc/ folder by verifying every claim against the current repository state and tooling.

Changes

doc/dev/dev_setup.md
  • Fixed H1 title: Was # Run SDK tests (wrong file name/purpose). Changed to # Developer Setup to match what the file is linked as in both READMEs.
doc/dev/tests.md
  • Python 3.10 Windows Store link: Updated from the old microsoft.com/p/ format to the new apps.microsoft.com/detail/ format (matching the already-updated 3.11 and 3.12 links on the same line).
  • Internal URL replaced: review.learn.microsoft.com is Microsoft's internal content review portal, inaccessible to external contributors. Replaced with the public learn.microsoft.com equivalent.
  • Keyvault test-resources links: Three reference links pointed to sdk/keyvault/test-resources.json pinned at an old SHA — that file no longer exists (migrated to .bicep). Updated to point to sdk/keyvault/test-resources.bicep at main.
  • docs.microsoft.com → learn.microsoft.com: Updated Azure CLI link at the bottom of the file.
doc/dev/mgmt/tests.md
  • docs.microsoft.com → learn.microsoft.com: Updated three Azure Active Directory tutorial links and one ARM REST API link. Microsoft migrated all docs from docs.microsoft.com to learn.microsoft.com.
doc/dev/mgmt/generation.md
  • Deprecated build command: Replaced python setup.py bdist_wheel with python -m build --wheel (the setup.py invocation is deprecated in modern Python tooling).
doc/dev/packaging.md
  • RST file references in setup.py example: The example read README.rst and HISTORY.rst. Current SDK packages use README.md and CHANGELOG.md. Updated the example to match current practice.
  • Python version classifiers: The example only listed classifiers up to Python 3.12, but the support policy covers 3.10–3.13+. Added the 3.13 classifier.
doc/dev/docstring.md
  • docs.microsoft.com → learn.microsoft.com: Updated two Form Recognizer documentation links.
doc/request_builders.md and doc/send_request.md
  • docs.microsoft.com → learn.microsoft.com: Updated all reference links at the bottom of both files (azure-core, azure-identity, and authentication documentation URLs).

Generated by Documentation Consistency Check · 146.6 AIC · ⌖ 14 AIC · ⊞ 5.8K · ◷

[!NOTE]
This was originally intended as a pull request, but GitHub Actions is not permitted to create or approve pull requests in this repository.
The changes have been pushed to branch doc/fix-documentation-inconsistencies-1bb2d58048901fb8.

Click here to create the pull request

To fix the permissions issue, go to Settings → Actions → General and enable Allow GitHub Actions to create and approve pull requests. See also: gh-aw FAQ

Show patch preview (238 of 238 lines) 
From 6be649ca07e55f3eda21ef8ee3eabce9368e8f4e Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Mon, 10 Aug 2026 05:17:32 +0000
Subject: [PATCH] Fix documentation inconsistencies in doc/ folder

- dev_setup.md: Fix H1 title from 'Run SDK tests' to 'Developer Setup'
- tests.md: Update Python 3.10 Windows Store link to use apps.microsoft.com format
- tests.md: Replace internal review.learn.microsoft.com URL with public learn.microsoft.com
- tests.md: Update keyvault test-resources links from deleted .json (pinned SHA) to current .bicep file
- tests.md: Update docs.microsoft.com link to learn.microsoft.com
- mgmt/tests.md: Update docs.microsoft.com links to learn.microsoft.com
- mgmt/generation.md: Replace deprecated 'python setup.py bdist_wheel' with 'python -m build --wheel'
- packaging.md: Update setup.py example to use README.md/CHANGELOG.md instead of README.rst/HISTORY.rst
- packaging.md: Add Python 3.13 classifier to example (was only listing up to 3.12)
- docstring.md: Update docs.microsoft.com links to learn.microsoft.com
- request_builders.md: Update docs.microsoft.com links to learn.microsoft.com
- send_request.md: Update docs.microsoft.com links to learn.microsoft.com

Co-authored-by: Copilot <[email protected]>
---
 doc/dev/dev_setup.md       |  2 +-
 doc/dev/docstring.md       |  4 ++--
 doc/dev/mgmt/generation.md |  2 +-
 doc/dev/mgmt/tests.md      |  6 +++---
 doc/dev/packaging.md       |  5 +++--
 doc/dev/tests.md           | 12 ++++++------
 doc/request_builders.md    | 18 +++++++++---------
 doc/send_request.md        | 18 +++++++++---------
 8 files changed, 34 insertions(+), 33 deletions(-)

diff --git a/doc/dev/dev_setup.md b/doc/dev/dev_setup.md
index d126ede3..0a68c396 100644
--- a/doc/dev/dev_setup.md
+++ b/doc/dev/dev_setup.md
@@ -1,4 +1,4 @@
-# Run SDK tests
+# Developer Setup
 
 This document describes how to create a dev environment in order to run SDK tests
 o
... (truncated)
Lenguaje dominante
Python
Estrellas
5.6k
Forks
3.4k
Merge medio
2 d 7 h
PR fusionados (30 d)
181

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Azure/azure-sdk-for-python

Todos los issues de Azure/azure-sdk-for-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.