chipsalliance/chisel

Update docs/README.md

Open

#4,402 opened on Sep 16, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Scala (651 forks)batch import
good first issue

Repository metrics

Stars
 (4,658 stars)
PR merge metrics
 (Avg merge 3d 21h) (16 merged PRs in 30d)

Description

It's a bit dated, it needs to tell people where to put docs, how to run mdoc and view the result, and how to build the website to see it rendered.

Contributor guide

Research direction
Update the README to include instructions for placing documentation files, running mdoc to verify, and building the website for preview.
Tech stack
scala
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.
80