Update the docs after 3.1.1: Twig is required, the @OA note and the contributor workflow

Abierto
#164 0 comentarios 0 reacciones 0 asignados Ver en GitHub

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

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

documentation

Summary

Three places in the docs repository do not match the released 3.1.1 and the way we work now.

Why

  1. Twig is a required dependency again (quantum-php/framework#626, in 3.1.1): twig/twig ^3.27 is in the framework's require, and RendererException::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.
  2. The @OA note in the CLI guide is a long paragraph that repeats what the upgrade guide already explains.
  3. AGENTS.md still tells contributors to branch from master and open the pull request into master, while pages are written on a docs/<topic> branch from staging and published by a release pull request from staging into master.

Pages

  • Twig, v3.0/core-concepts/views.md (the paragraph that says Twig is "an optional renderer dependency"), v3.0/installation.md (twig/twig in 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) and v3.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 update installs it, an application that pins an older Twig must allow ^3.27, and the removed RendererException::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 @OA note to one sentence with a link to the OpenAPI item of the upgrade guide.
  • AGENTS.md, "Git Workflow": branch from staging, open the pull request into staging and link the ticket with Refs #n (a Closes line only works for a pull request into master), and publish with a release pull request from staging into master whose 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 staging and 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

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de quantum-php/docs

Todos los issues de quantum-php/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.