Update the docs after 3.1.1: Twig is required, the @OA note and the contributor workflow

Đang mở
#164 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

Chưa có ai nhận issue này.

Đánh giá

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

Hướng nghiên cứu

Start with the listed Twig pages, v3.0/upgrade-guide.md, v3.0/cli/code-generation.md, and AGENTS.md; compare the 3.1.1 dependency and changelog details with the linked framework release. Then update the contributor workflow and check the edited internal links and anchors. Done means each Twig fact is stated once at its home page, the CLI note links to the upgrade guide, and the workflow describes staging and release pull requests as specified.

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

Mô tả

documentation

Summary

Three places in the docs repository do not match the released 3.1.1 and the way we work now.

Why

  1. Twig is a required dependency again (quantum-php/framework#626, in 3.1.1): twig/twig ^3.27 is in the framework's require, and RendererException::twigNotInstalled() and the adapter's "Twig is missing" check were removed. The pages still say Twig is optional and must be installed separately, so a reader is misled.
  2. The @OA note in the CLI guide is a long paragraph that repeats what the upgrade guide already explains.
  3. AGENTS.md still tells contributors to branch from master and open the pull request into master, while pages are written on a docs/<topic> branch from staging and published by a release pull request from staging into master.

Pages

  • Twig, v3.0/core-concepts/views.md (the paragraph that says Twig is "an optional renderer dependency"), v3.0/installation.md (twig/twig in the list of optional packages), v3.0/packages/renderer/overview.md (the "Twig support is optional" paragraph and the sentence about the adapter failing when Twig is not installed) and v3.0/packages/renderer/adapters.md: state that Twig comes with the framework, and drop the optional wording. Each fact is stated once at its home page and linked elsewhere.
  • Twig, v3.0/upgrade-guide.md: a short item in the 3.0 to 3.1 part: Twig is required again, composer update installs it, an application that pins an older Twig must allow ^3.27, and the removed RendererException::twigNotInstalled(). The 2.x to 3.0 note about 3.0.3 stays as it is, because it describes that release.
  • v3.0/cli/code-generation.md: shorten the @OA note to one sentence with a link to the OpenAPI item of the upgrade guide.
  • AGENTS.md, "Git Workflow": branch from staging, open the pull request into staging and link the ticket with Refs #n (a Closes line only works for a pull request into master), and publish with a release pull request from staging into master whose description has the closing keyword before every number (Closes #a, closes #b).

Acceptance criteria

  • every statement matches the framework code and changelog of 3.1.1
  • each fact is stated once at its home page and linked elsewhere
  • internal links and anchors resolve
  • the pull request goes into staging and is published with the next documentation release
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
3
Fork
1
Merge trung bình
2 phút
Pull request đã merge (30 ngày)
26

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 quantum-php/docs

Tất cả issue của quantum-php/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.