Docs hosted at https://everyinc.github.io/compound-engineering-plugin are not easily discoverable on GitHub

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
45/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
停滞
技术栈
github
领域
documentation

调研方向

Update the repository’s GitHub About section to link to https://everyinc.github.io/compound-engineering-plugin. Start with the repository settings or the existing project metadata that controls its About section. Done when the docs link is visible from the repository landing page.

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

描述

documentation

Great plugin! Thanks so much for sharing.

Just wanted to note that it was not obvious from initial glance at this GitHub page how to navigate to the docs hosted at https://everyinc.github.io/compound-engineering-plugin.

I eventually found them by checking the recent deployment history, but I think adding this link to the About section on the repo, so it shows up clearly in the repo landing page, would be very useful!

E.g., like this!

Image
主要语言
TypeScript
星标
25.6k
派生
2.1k
平均合并
3 小时 57 分钟
30 天内合并 PR
170

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

EveryInc/compound-engineering-plugin 的其他 Issue

查看 EveryInc/compound-engineering-plugin 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

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