Documentation urls should always include version number
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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-propertieslinks 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)
- Dominant language
- MDX
- Stars
- 621
- Forks
- 3.2k
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 86
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ionic-team/ionic-docs
-
content
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
ionic-team/ionic-docs#4705 ·
-
content package: angular
Difficulty 2/5 Half a day Newbie friendliness 78/100
ionic-team/ionic-docs#4702 ·
-
triage
Difficulty 1/5 Under an hour Newbie friendliness 80/100
ionic-team/ionic-docs#4546 ·
-
content: broken link Opencontent
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ionic-team/ionic-docs#4381 · 2 comments ·
-
triage
Difficulty 1/5 Under an hour Newbie friendliness 72/100
ionic-team/ionic-docs#3639 ·
All issues in ionic-team/ionic-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
certification
Difficulty 1/5 Under an hour Newbie friendliness 80/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
bisq-network/support#2181 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
tutorial updates Open
Difficulty 1/5 Under an hour Newbie friendliness 80/100
sveltejs/svelte.dev#2241 ·