Broken images in Python Tutorial and FastAPI Tutorial after Python Environments refactor

Đang mở
#10,553 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@alok-108 đang làm issue này rồi.

Từ ngày 28/10/2026.

  • #10558 của @alok-108 — đang mở

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Read docs/python/python-tutorial.md and docs/python/tutorial-fastapi.md, then inspect the current images in docs/python/images/environments/ and compare them with the environment creation steps in both tutorials. Update the outdated image references and walkthrough to match the current workflow; done means the referenced images exist and the screenshots accurately illustrate the steps.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

triage-needed
Summary

In the official Python tutorial (docs/python/python-tutorial.md) and the FastAPI tutorial (docs/python/tutorial-fastapi.md), several environment creation screenshots are broken and returning 404 on the live website code.visualstudio.com/docs/python/python-tutorial.

Cause

In commit 938e7e2b0 (#9364 - "docs: update Python environments documentation for release of Python Envs Ext as default"), several legacy environment image files were removed from docs/python/images/environments/:

  • create_environment_dropdown.png
  • interpreters-list.png
  • create_environment_prompt_status.png

However, references to these deleted images remain in:

  1. docs/python/python-tutorial.md:
    • Line 105: ![Create Environment dropdown](images/environments/create_environment_dropdown.png)
    • Line 111: ![Virtual environment interpreter selection](images/environments/interpreters-list.png)
    • Line 117: ![Create environment status notification](images/environments/create_environment_prompt_status.png)
  2. docs/python/tutorial-fastapi.md:
    • Line 76: ![Dropdown with "Venv" or "Conda" as options for environments that can be created with the Python: Create Environment command](images/environments/create_environment_dropdown.png)
Screenshot (from live documentation page)

Broken images on Python Tutorial

Live HTTP verification:

$ curl -I https://code.visualstudio.com/assets/docs/python/environments/create_environment_dropdown.png
HTTP/1.1 404 The requested content does not exist.
Proposed Fix

Update docs/python/python-tutorial.md and docs/python/tutorial-fastapi.md to align the walkthrough and images with the modern Python environment creation workflow (referencing the current images in docs/python/images/environments/, such as quickCreate.png and selectedInterpreter.png).

I would be glad to submit a PR to resolve this!

Ngôn ngữ chính
Markdown
Star
6.7k
Fork
5.8k
Merge trung bình
18 giờ 49 phút
Pull request đã merge (30 ngày)
116

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của microsoft/vscode-docs

Tất cả issue của microsoft/vscode-docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.