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

オープン
#164 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
74/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
markdown, php
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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
主要言語
言語のデータがありません
スター
3
フォーク
1
平均マージ
2分
マージ済み PR(30日)
26

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

quantum-php/docs のほかの issue

quantum-php/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。