Update the docs after 3.1.1: Twig is required, the @OA note and the contributor workflow
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 74/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- markdown, php
- Domain
- documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- No language data
- Stars
- 3
- Forks
- 1
- Avg merge
- 2m
- Merged PRs (30d)
- 26
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from quantum-php/docs
-
documentation
Difficulty 3/5 1-2 days Newbie friendliness 72/100
quantum-php/docs#155 ·
Maintainers usually reply within 1 day
All issues in quantum-php/docs
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 86/100
py-econometrics/pyfixest#2072 ·
Maintainers usually reply within 1 day
-
~planning docs
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Kromatic-Innovation/athenaeum#3084 ·
Maintainers usually reply within 1 day
-
Could Have good first issue ui
Difficulty 1/5 Under an hour Newbie friendliness 85/100
hannahro15/Musical-Match-Saga#272 ·
Maintainers usually reply within 1 day
-
good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
dutchman-cad/dutchman#874 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 72/100
MUKE-coder/grit#243 ·