Skip to content

Document project architecture in README #290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
radhikatbbt wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document project architecture in README #290

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53418ef
Document project architecture in README
radhikatbbt Jul 4, 2026
11d8f90
Merge branch 'main' into patch-1
radhikatbbt Jul 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,25 @@ Polars proved you can rewrite the data layer in Rust and win. mohu is that same
- SIMD-accelerated math operations
- Memory layouts NumPy cannot express

## Status
## project architecture

this repo is organized as a cargo workspace. here's a quick map of where things live:
- **`crates/`** — the actual library code, split into individual crates (core arrays, dispatch, compute kernels, I/O, etc). this is where most contributions happen.
- **`tests/`** — integration tests that exercise the public API across crates, separate from the unit tests inside each crate.
- **`examples/`** — small standalone programs showing how to use mohu, meant to be read and run directly.
- **`docs/`** — longer-form documentation and design notes that don't fit in the README.
- **`benches/`** — performance benchmarks used to track regressions and validate the "parallel by default" and zero-copy goals.
- **`scripts/`** — developer tooling and automation scripts (setup, checks, etc) that aren't part of the library itself.

- mohu/
├── crates/ # library code, one crate per component
├── tests/ # cross-crate integration tests
├── examples/ # runnable usage examples
├── docs/ # extended documentation
├── benches/ # performance benchmarks
└── scripts/ # dev tooling and automation
Comment on lines +35 to +41

@coderabbitai coderabbitai Bot Jul 4, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Fence the tree diagram.

As written, this block will render like normal list text, so the tree alignment is likely to break in Markdown. Wrap the diagram in a fenced code block to keep the layout readable.

Suggested fix 
- - mohu/
- ├── crates/       # library code, one crate per component
- ├── tests/        # cross-crate integration tests
- ├── examples/     # runnable usage examples
- ├── docs/         # extended documentation
- ├── benches/      # performance benchmarks
- └── scripts/      # dev tooling and automation
+ ```text
+ mohu/
+ ├── crates/       # library code, one crate per component
+ ├── tests/        # cross-crate integration tests
+ ├── examples/     # runnable usage examples
+ ├── docs/         # extended documentation
+ ├── benches/      # performance benchmarks
+ └── scripts/      # dev tooling and automation
+ ```
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- mohu/
├── crates/ # library code, one crate per component
├── tests/ # cross-crate integration tests
├── examples/ # runnable usage examples
├── docs/ # extended documentation
├── benches/ # performance benchmarks
└── scripts/ # dev tooling and automation
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 35 - 41, The README tree diagram is currently written
as plain text, so Markdown may render it as a broken list instead of preserving
alignment. Update the README section containing the repository layout by
wrapping the tree under the existing top-level entry in a fenced code block,
keeping the directory names and comments intact so the diagram renders correctly
and remains readable.


## status

Early. The foundation is being laid. If you believe the Python numerical stack deserves a rewrite, watch this repository or contribute.

Expand Down
Loading