ionic-team / ionic-team/ionic-docs

Documentation urls should always include version number

Offen
#1,736 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
feature request structural
Vorherrschende Sprache
MDX
Sterne
621
Forks
3.2k
Ø Merge
1 T. 2 Std.
Gemergte PRs (30 T.)
86

Beschreibung

**Is your feature request related to a problem? Please describe.**
Old blog or forum posts, stackoverflow that links to the ionic docs often point to the wrong version of the documentation.
Examples :
- https://ionicframework.com/blog/introducing-ionic-4-ionic-for-everyone/ the link to the Migration guide is https://ionicframework.com/docs/building/migration/ but should be https://ionicframework.com/docs/v4/building/migration/
- https://stackoverflow.com/a/55202668/2765126 the link to the `css-custom-properties` links to the current doc that includes more properties than in v4 so it's confusing

**Describe the solution you'd like**
- Always include the version number in the documentation urls (even the current version)
- If no version is added redirect to current version (to prevent dead links)

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start by locating how documentation URLs and versioned paths are generated in this repository, then inspect the routing or redirect configuration for unversioned links. Compare the current and v4 examples from the issue; done means versioned documentation URLs are used consistently and unversioned URLs redirect to the current version without breaking existing links.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.