Update the docs after 3.1.1: Twig is required, the @OA note and the contributor workflow
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 74/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- markdown, php
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 3
- Fork
- 1
- Merge medio
- 2m
- PR unite (30g)
- 26
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di quantum-php/docs
-
documentation
Difficoltà 3/5 1-2 giorni Idoneità per principianti 72/100
quantum-php/docs#155 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di quantum-php/docs
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 86/100
py-econometrics/pyfixest#2072 ·
I maintainer di solito rispondono entro 1 giorno
-
~planning docs
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
Kromatic-Innovation/athenaeum#3084 ·
I maintainer di solito rispondono entro 1 giorno
-
Could Have good first issue ui
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
hannahro15/Musical-Match-Saga#272 ·
I maintainer di solito rispondono entro 1 giorno
-
good first issue help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
dutchman-cad/dutchman#874 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
MUKE-coder/grit#243 ·