OpenDevicePartnership / OpenDevicePartnership/OpenDevicePartnership.github.io

Dynamic Repository Diagrams

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

还没有人认领这个 Issue。

主要语言
Rust
星标
1
派生
10
平均合并
5 天 22 小时
30 天内合并 PR
1

描述

The Projects landing page has 3 main links for P (Patina), EC, and ES (EC Services) which bring up a page with What, Why, Who, and a repository diagram.

This task covers improvements for those diagrams:

  1. Create an engine that auto-generates the diagram each time the user opens the page instead of relying on a user updated jpg. Maybe pull topics from each repo for determining how to use the URLs?
  2. Add text to the auto-generated diagram to explain what it is and how to read it. The text needs to be geared to a new engineer browsing the web site.
  3. Create an action in this repo that creates a bug if any repository is found that does not provide the necessary hooks for the diagram engine.

贡献指南

这个仓库没有索引到贡献指南

从这里开始

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

调研方向

检查 Projects 登陆页及其指向 Patina、EC 和 EC Services 的链接,然后追踪当前的 repository 图表是如何提供的。定义图表引擎、面向新贡献者的说明文本以及所需的 repository 验证;完成标准是页面访问时生成图表,并由自动化 action 报告缺少所需 hooks 的 repository。

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

评估

技术栈
github-actions, rust
领域
documentation, tooling
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

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