reworkd/AgentGPT

✨ Create a guide on how to update the documentation website

Open

#869 创建于 2023年6月27日

在 GitHub 查看
 (24 评论) (0 反应) (0 负责人)TypeScript (34,594 star) (9,446 fork)batch import
good first issuehelp wanted

描述

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!)

贡献者指南

技术栈
无
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic MarkdownGit and GitHubFamiliarity with mintlifyLocal development environment
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90
研究方向
Investigate the existing documentation site structure, likely found in the repository's docs/ folder or a separate mintlify configuration. Review the mintlify documentation to understand its syntax and capabilities. Engage with the comments on the issue (there are 24) to see if maintainers have provided specific preferences or templates. Then create a new guide page following the existing style.