ionic-team / ionic-team/ionic-docs
Documentation urls should always include version number
未关闭
还没有人认领这个 Issue。
feature request
structural
- 主要语言
- MDX
- 星标
- 621
- 派生
- 3.2k
- 平均合并
- 1 天 2 小时
- 30 天内合并 PR
- 86
描述
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)
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先定位此仓库中如何生成文档 URL 和带版本的路径,然后检查针对无版本链接的路由或重定向配置。比较 issue 中当前版本和 v4 的示例;当文档 URL 一致地使用版本路径,并且无版本 URL 在不破坏现有链接的情况下重定向到当前版本时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 领域
- documentation
- Issue 类型
- 功能
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 30/100