MLH-Fellowship/howdoi-dashboard

Write documentation

Open

#4 opened on Jul 29, 2021

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees) (0 forks)github user discovery
documentationenhancementgood first issue

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Once the project is almost complete, we need to have documentation for howdoi dashboard .

Contributor guide

Research direction
Explore the project structure, understand the existing code, and create a documentation file (e.g., README.md) describing the dashboard's purpose, setup, and usage.
Tech stack
None
Domain
documentation
Issue type
Documentation
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