Solution about Document tutorial & README generation

[innovation64]

Discussion: talk about the solution for Document tutorial & README generation

• README Generation.
• Generation of Public Tutorial Documentation.

Document tutorial method

README method

[Umpire2018]

似乎 tutorial 生成可以参照项目 https://github.com/Codium-ai/pr-agent

[Guo-Zhang]

Reference:

• https://github.com/gusye1234/gpt-readme
• https://github.com/ycjcl868/readme-gpt

[innovation64]

readme-md-generator：

GitHub: https://github.com/kefranabg/readme-md-generator 描述：这是一个简单的 CLI 工具，用于快速生成一个 README.md 文件。它会通过提出问题来自动填充 README 的结构。 Make a README：

网站：https://www.makeareadme.com/ 描述：虽然这不是一个开源项目，但它提供了一个简单的界面来帮助你构建基本的 README 结构。非常适合初学者。 DocToc：

GitHub: https://github.com/thlorenz/doctoc 描述：为你的 README 自动生成目录（Table of Contents），非常适合长文档。 Standard Readme：

GitHub: https://github.com/RichardLitt/standard-readme 描述：这个项目旨在制定 README 文件的标准格式，虽然它不是自动生成工具，但提供了很好的写作指南。 Readme.so：

网站：https://readme.so/ 描述：提供一个简单的编辑器，通过选择不同的部分来构建 README 文件。虽然不是完全自动化，但可以快速生成基本结构。

[OctoberFox11]

调查笔记

1. README.md生成格式参看[[md生成指南]]
2. MD辅助生成网站及feature： (以下信息基于网站简介，且皆非开源项目)
   • Build optimized websites quickly, focus on your content | Docusaurus
     • 基于REACT的wiki
   • DAUX.IO
     • 提供自动生成索引和排序
   • GitBook – Knowledge management for technical teams
     • Gitbook AI辅助提取重要信息
     • issue对话信息自动整理
   • MkDocs
     • 开发过程中随时更新
     • 生成静态html网站
   • Full featured documentation deployment platform - Read the Docs
     • not interesting
   • ReadMe
     • 对每个访问API都提供个性化Documentation

     • 适合开发者分析程序API调用情况

[innovation64]

目前README设计思路：

• 先获取git仓库的相关信息
• 总结MD相关信息，并按要求分类输出（LLM总结）
• 制作README各组件模块prompt（模板参考上面的几个仓库网址）
• 给予用户补充信息
• 根据分类的信息补充信息与模板送入LLM分块生成
• 拼接输出REAMD.md

时间安排： 1.21 写完template逻辑 1.22 初步demo

[Umpire2018]

1. 按照以上逻辑进行自研开发
2. 优先完成 README generation，再者是 Tutorial generation ，未来计划有：输出 html, issue 总结
3. Demo 期望实现时间为 2024/1/30