opensearch-project/demos

[FEATURE][DocBot] README revamp

Open

#89 opened on Nov 6, 2023

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees) (18 forks)auto 404
OSCIdocumentationenhancementgood first issue

Repository metrics

Stars
 (4 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Review the current README.md, understand the project's structure and components, and draft an updated README that includes a project description, overview of parts, and possibly installation/usage instructions.
Tech stack
None
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90