reworkd/AgentGPT

✨ Create a guide on how to update the documentation website

开放

#869 创建于 2023年6月27日

在 GitHub 查看贡献者指南
 (24 条评论) (0 个反应) (0 位负责人)TypeScript (9,446 个派生)batch import
good first issuehelp wanted

仓库指标

星标
 (34,594 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

We should update the docs site (https://docs.reworkd.ai/development) with some documentation for how to update the docs site itself. It should cover the following:

  • Intro on what mintlify is and link to it
  • Talk about how to run the site locally
  • Talk about how to update a page or create a new page
  • Talk about exactly what we want documented
  • Talk about how to request for documentation (Make an issue on GitHub!)

贡献者指南

研究方向
调查现有文档站点结构，可能在仓库的 docs/ 文件夹或单独的 mintlify 配置中。查阅 mintlify 文档以了解其语法和功能。查看该议题下的评论（共有 24 条），了解维护者是否提供了具体偏好或模板。然后按照现有风格创建一个新的指南页面。
技术栈
typescript
领域
developer experience
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80