Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Versioned docs: a version switcher, main plus each release

Abierto
  • ¿Algo no está bien?
#289 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
nuxt, typescript
Área
documentation

Línea de trabajo

Start by reading the docs site's Nuxt Content configuration and its Vercel prerender setup to see how content collections and routes are built. The issue leaves hosting and the first version branch timing undecided, so those decisions need to be resolved before implementation. Done means readers can switch versions, land on the latest release by default, and find matching pages across versions while search and the quiz use the selected or specified version.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Daniel (2026-10-21): the docs should have versions you can switch between. One version is main, the docs for the release being prepared. The default is the latest release. Later, every release keeps its own docs, so readers can look back at older versions.

How API Platform and Symfony do it

Both keep the docs in their own repo, with one branch per minor version, and the site has a version switcher.

  • API Platform (api-platform/docs): branches 1.0 … 4.4, 5.0 and main. The default branch is 4.3, where most fixes land before they're merged forward.
  • Symfony (symfony/symfony-docs): branches 2.0 … 8.2. The default is 7.4, the LTS. Contributors target the oldest maintained branch a change applies to, and maintainers merge it up. URLs carry the version (/doc/7.4/…), and /doc/current/ points to the latest stable. A versionadded note marks what a version added.

For CWA

  • Version scheme: the three projects share 2.0.0 from the beta, and the template and create-cwa share one version. So the docs could branch per CWA minor (2.0, 2.1, …), plus main. Before 2.0.0 there's one prerelease line: main and latest (the newest alpha or beta).
  • Building: the site is prerendered to Vercel. Options are a separate deploy per branch on a subdomain or path, or one build that renders each branch's content/ under /<version>/. Nuxt Content can take more than one collection from a git source.
  • Default and switcher: / and unversioned links go to the latest release, and a header select switches version. Links between versions keep the path when the page exists.
  • Search, llms.txt and the quiz: search should cover the selected version, and llms.txt the latest. The quiz is pinned to doc sections by hash, so it needs one version, probably the latest.
  • Markers: keep *Since [template 2.0.0-alpha.N](…)*. In a version's own branch, on main after … notes become release notes or drop out.
  • Process: document a change on main when it lands (as now). When a release is cut, branch or tag the docs, and backport fixes to the latest release branch.

Not started. Needs a decision on hosting, and on when to cut the first version branch (at the beta?).

Lenguaje dominante
TypeScript
Estrellas
0
Forks
0
Merge medio
1 h 20 min
PR fusionados (30 d)
1

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 components-web-app/docs

Todos los issues de components-web-app/docs

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.