Versioned docs: a version switcher, main plus each release
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- nuxt, typescript
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.0andmain. The default branch is4.3, where most fixes land before they're merged forward. - Symfony (symfony/symfony-docs): branches
2.0…8.2. The default is7.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. Aversionaddednote 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, …), plusmain. Before 2.0.0 there's one prerelease line:mainandlatest(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.txtand the quiz: search should cover the selected version, andllms.txtthe 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
mainwhen 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?).
- Lingua principale
- TypeScript
- Stelle
- 0
- Fork
- 0
- Merge medio
- 1h 20m
- PR unite (30g)
- 1
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 components-web-app/docs
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 73/100
components-web-app/docs#297 ·
-
documentation
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
components-web-app/docs#290 · 2 commenti ·
-
documentation
Difficoltà 4/5 3-5 giorni Idoneità per principianti 43/100
components-web-app/docs#285 ·
-
documentation
Difficoltà 4/5 1-2 giorni Idoneità per principianti 35/100
components-web-app/docs#284 ·
-
enhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 15/100
components-web-app/docs#237 · 2 commenti ·
Tutte le issue di components-web-app/docs
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
maniator/verticopolis#1303 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
listFeatures/getFeatureExamples never return Kotlin examples for Android or server Kotlin SDKsAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
appwrite/mcp-for-docs#23 · 1 commento ·
-
`@vanilla-extract/turbopack-plugin`: "getImageSize is not a function" with Next.js 16.4.x when a `.css.ts` file imports an imageForse già presa @aevarOrigo l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
vanilla-extract-css/vanilla-extract#1799 · 1 commento ·
-
native
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
prime-radiant-inc/evener#4839 ·
I maintainer di solito rispondono entro 1 giorno
-
MCP endpoint matches the Authorization scheme case-sensitively and logs the same reason for "absent" and "wrong scheme" (ChatGPT connector gets missing_bearer_token)Forse già presa Una pull request collegata a questa issue è aperta o già unita. Apertabug needs-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
I maintainer di solito rispondono entro 1 giorno