opensearch-project/demos

[FEATURE][DocBot] README revamp

开放

#89 创建于 2023年11月6日

在 GitHub 查看贡献者指南
 (1 条评论) (0 个反应) (0 位负责人) (18 个派生)auto 404
OSCIdocumentationenhancementgood first issue

仓库指标

星标
 (4 个星标)
PR 合并指标
 (30 天内没有已合并 PR)

描述

Is your feature request related to a problem?

Since starting DocBot we have made a lot of progress however our README.md file has not kept up. We need to describe what the DocBot project does succinctly and give an overview of it's parts.

What solution would you like?

Updated README.md file

贡献者指南

研究方向
检查当前 README.md，了解项目的结构和组成部分，起草更新的 README，包括项目描述、各部分概述，以及可能的安装/使用说明。
技术栈
无
领域
documentation
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90