Update the docs after 3.1.1: Twig is required, the @OA note and the contributor workflow
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 74/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- markdown, php
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 3
- Forks
- 1
- Merge medio
- 2 min
- PR fusionados (30 d)
- 26
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de quantum-php/docs
-
documentation
Dificultad 3/5 1-2 días Aptitud para principiantes 72/100
quantum-php/docs#155 ·
Los mantenedores suelen responder en 1 día
Todos los issues de quantum-php/docs
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 86/100
py-econometrics/pyfixest#2072 ·
Los mantenedores suelen responder en 1 día
-
~planning docs
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
Kromatic-Innovation/athenaeum#3084 ·
Los mantenedores suelen responder en 1 día
-
Could Have good first issue ui
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
hannahro15/Musical-Match-Saga#272 ·
Los mantenedores suelen responder en 1 día
-
good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
dutchman-cad/dutchman#874 ·
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
MUKE-coder/grit#243 ·