Skip to content

Add beginner-friendly RTL docs and VS Code workflows#54

Open
Xuefei-Zhang wants to merge 17 commits intoadam-maj:masterfrom
Xuefei-Zhang:xuefei/docs-mermaid-guides
Open

Add beginner-friendly RTL docs and VS Code workflows#54
Xuefei-Zhang wants to merge 17 commits intoadam-maj:masterfrom
Xuefei-Zhang:xuefei/docs-mermaid-guides

Conversation

@Xuefei-Zhang
Copy link
Copy Markdown

Summary

  • annotate the SystemVerilog source files to make the RTL easier for beginners to read alongside the code
  • add per-module learning docs and repository analysis chapters with Mermaid diagrams
  • add VS Code tasks and launch settings for module compilation, full tests, and log inspection

Test Plan

  • make test_matadd
  • make test_matmul

Xuefei-Zhang and others added 17 commits March 30, 2026 17:29
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant