main page file deduplication & broken links with rdoc 8
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 48/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- ruby
调研方向
首先查看 PR #1624,并比较 RDoc 7 和 RDoc 8 为 README_md.html 和 index.html 生成的输出。追踪主页面 URL 和入站链接的选择方式,然后在不恢复冗余内容的情况下,定义并验证现有 README_md.html 链接的预期行为。
由索引模型根据 Issue 内容生成。
描述
PR #1624 removed the redundant main-page file. That is easily the correct behaviour, but existing projects may have that URL published/indexed/linked externally, and regenerating with rdoc 8 could now break inbound links.
In my own case, a README_md.html no longer existed because it duplicated index.html, and this broke one of my own bookmarks to my own project because I hadn't pinned rdoc 7 for the CI publish action. No doubt other folks will also get some surprise 404s.
- 主要语言
- Ruby
- 星标
- 928
- 派生
- 471
- 平均合并
- 2 天 4 分钟
- 30 天内合并 PR
- 13
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
ruby/rdoc 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentation可能已有人在做 @OskarEichler 于 64 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
markdown html excerpt includes link parts可能已有人在做 @anyingiit 于 10 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 66/100
维护者通常 1 天内回复
-
Regexp generated from unescaped input in #expand_class可能已有人在做 @jaynetics 于 23 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 25/100
维护者通常 1 天内回复
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 82/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
yegor256/intercepted#128 ·
-
documentation good first issue
难度 1/5 1 小时以内 新手友好度 85/100
ysb3996-blip/oops#51 ·
维护者通常 1 天内回复
-
good first issue
难度 1/5 1 小时以内 新手友好度 72/100
维护者通常 1 天内回复
-
Remove leftover Cloud66 custom_web process from Procfile可能已有人在做 @ShahadatTest 今天认领。 未关闭Difficulty: Easy Good First Issue
难度 1/5 1 小时以内 新手友好度 88/100
rubyforgood/casa#7330 · 1 条评论 ·
维护者通常 1 天内回复