Repository navigation
ram: Initial documentation #9872
Description
The ram module requires initial documentation, both from a user standpoint and a developer standpoint.
A readme should be created similar to other tool readme's in the repo, which explains how a user can use the tool and what all of the arguments mean. As features are added or adjusted, the readme should be kept up-to-date.
More developer documentation should be added, including describing the general approach for constructing the RAM, how the layout class works, Doxygen-style comments on functions, and explanations of any code that might be unintuitive.
Activity
[-]Initial documentation[/-][+]ram: Initial documentation[/+]AyushBurde commentedon Mar 22, 2026
can i work on this?
maliberty commentedon Mar 22, 2026
There is a PR open already.
maliberty commentedon Mar 22, 2026
#9873 is already open
rovinski commentedon Mar 23, 2026
@AyushBurde you can look at #9392 for one of the many tasks which is not being done yet.
github-actions commentedon May 22, 2026
This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 21 days if no further activity occurs. Remove the
Stalelabel or comment to keep it open.maliberty commentedon Jul 17, 2026
@rovinski still relevant given #9873 is merged?
rovinski commentedon Jul 18, 2026
Originally, I wanted Doxygen-style comments and better comments on the code architecture. But these days, I feel that it is becoming more and more moot with LLMs. I'm fine to close this.