Update the docs after 3.1.1: Twig is required, the @OA note and the contributor workflow
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 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 分鐘
- 30 天內合併 PR
- 26
環境準備
這個專案沒有提供開發容器、Dockerfile 或貢獻指南,環境需要你自己搭建:先看它的 README,通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
quantum-php/docs 的其他 Issue
-
documentation
難度 3/5 1-2 天 新手友好度 72/100
quantum-php/docs#155 ·
維護者通常 1 天內回覆
相似的 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 ·