ruby / ruby/docs.ruby-lang.org

Generate all Ruby versions' documentation with the latest (released) RDoc

未关闭
#153 0 条评论 4 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Ruby
星标
53
派生
27
平均合并
1 小时 39 分钟
30 天内合并 PR
2

描述

I recently made quite a few theme improvements to RDoc, along with community contributed changes like SEO tags...etc., which are all applied to the master documentation (https://docs.ruby-lang.org/en/master/index.html).
But since most of users will still be using Ruby 3.3 and prior versions for years to come, I think it'd be better if we can apply the same changes to their documentation too. I'd appreciate some pointers or even collaborations to make that happen. Thank you 🙂

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

将 docs.ruby-lang.org/en/master/index.html 中的 master 文档与 Ruby 3.3 及更早版本的版本化文档进行比较,以确定生成方面的差异。然后检查此仓库的文档生成入口点,并确定如何将最新发布的 RDoc 应用于受支持的 Ruby 版本;当版本化站点包含所请求的 theme 和 SEO 改进时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
ruby
领域
build-system, documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。