Update the docs after 3.1.1: Twig is required, the @OA note and the contributor workflow
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 74/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- markdown, php
調査の方向性
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 の本文から書いたものです。
説明
Summary
Three places in the docs repository do not match the released 3.1.1 and the way we work now.
Why
- Twig is a required dependency again (quantum-php/framework#626, in 3.1.1):
twig/twig^3.27is in the framework'srequire, andRendererException::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. - The
@OAnote in the CLI guide is a long paragraph that repeats what the upgrade guide already explains. AGENTS.mdstill tells contributors to branch frommasterand open the pull request intomaster, while pages are written on adocs/<topic>branch fromstagingand published by a release pull request fromstagingintomaster.
Pages
- Twig,
v3.0/core-concepts/views.md(the paragraph that says Twig is "an optional renderer dependency"),v3.0/installation.md(twig/twigin 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) andv3.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 updateinstalls it, an application that pins an older Twig must allow^3.27, and the removedRendererException::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@OAnote to one sentence with a link to the OpenAPI item of the upgrade guide.AGENTS.md, "Git Workflow": branch fromstaging, open the pull request intostagingand link the ticket withRefs #n(aClosesline only works for a pull request intomaster), and publish with a release pull request fromstagingintomasterwhose 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
stagingand is published with the next documentation release
- 主要言語
- 言語のデータがありません
- スター
- 3
- フォーク
- 1
- 平均マージ
- 2分
- マージ済み PR(30日)
- 26
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
quantum-php/docs のほかの issue
-
documentation
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
quantum-php/docs#155 ·
メンテナーはふだん 1 日以内に返信
quantum-php/docs の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 86/100
py-econometrics/pyfixest#2072 ·
メンテナーはふだん 1 日以内に返信
-
~planning docs
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
Kromatic-Innovation/athenaeum#3084 ·
メンテナーはふだん 1 日以内に返信
-
Could Have good first issue ui
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
hannahro15/Musical-Match-Saga#272 ·
メンテナーはふだん 1 日以内に返信
-
good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
dutchman-cad/dutchman#874 ·
メンテナーはふだん 1 日以内に返信
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
MUKE-coder/grit#243 ·