docs: add a README to @relkit/client
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 79/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- bun, typescript
调研方向
阅读 WRITING.md 并检查现有的 client 包文件，以了解类型化 client 及其 API 参考文档的结构。添加 packages/client/README.md，其中包含简短说明、api.orders.list 示例，以及指向 relkit.dev 上 client 指南的链接。运行 bun run check；检查通过且添加到文档页面的任何示例都通过类型检查后，即表示完成。
由索引模型根据 Issue 内容生成。
描述
packages/client has no README.md, so its npm page is empty.
What to do
- Add
packages/client/README.md: what the typed client is, one short example of calling an API
reference such asapi.orders.list, and links to the client guide on https://relkit.dev. - Follow
WRITING.md(plain language, one product name).
Done when bun run check passes and the example type-checks if you add it to a docs page too.
- 主要语言
- TypeScript
- 星标
- 1
- 派生
- 0
- 平均合并
- 2 小时 45 分钟
- 30 天内合并 PR
- 64
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
rel-kit/relkit 的其他 Issue
-
documentation good first issue
难度 2/5 1-3 小时 新手友好度 86/100
维护者通常 1 天内回复
-
bug good first issue
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
bug good first issue
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
documentation good first issue
难度 1/5 1-3 小时 新手友好度 87/100
维护者通常 1 天内回复
-
documentation good first issue
难度 1/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
相似的 Issue
-
The sample email preview's ResizeObserver is never disconnected and keeps raising errors after leaving Settings可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭bug
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
area:ui bug effort:S priority:P2
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
Typo in WSL project description on Projects page可能已有人在做 @akhil9tiet 今天认领。 未关闭
难度 1/5 1 小时以内 新手友好度 75/100
microsoft/opensource.microsoft.com#1066 · 1 条评论 ·
-
ArcGIS Maps SDK for JavaScript c-carousel calcite-design-tokens enhancement impact - p3 - not time sensitive needs triage
难度 2/5 1-3 小时 新手友好度 68/100
Esri/calcite-design-system#15565 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
linkwarden/linkwarden#1891 ·
维护者通常 1 天内回复