chipsalliance/chisel

We have no documentation/training on `Mem`

Open

#2,324 opened on Jan 3, 2022

View on GitHub
 (5 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

Type of issue: documentation

Impact: no functional change

Development Phase: request

Other information

If the current behavior is a bug, please provide the steps to reproduce the problem:

We don't have any documentation that I can find on Mem in the Chisel bootcamp, or the website explanations docs or cookbooks. We only cover SyncReadMem.

What is the current behavior?

What is the expected behavior?

We should probably at least mention this in the explanations section

Please tell us about your environment:

What is the use case for changing the behavior?

Not having undocumented features

Contributor guide

Research direction
Search for 'Mem' in the Chisel documentation and bootcamp, then write a new explanation section covering its usage and differences from SyncReadMem.
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.
90