docs: refresh design documentation - #269
Merged
Merged
Conversation
Restructure document pages around current design, boundaries, flows, and limitations while keeping API details in rustdoc. Add mdBook config and current subsystem pages.
Contributor
There was a problem hiding this comment.
Code Review
This pull request refactors and updates the design documentation across various subsystems of the Comix kernel, including memory management, file systems, IPC, networking, synchronization, and logging, to align them with the current codebase and clarify design boundaries. A few minor typos were found in the ext4 documentation where 'adapters.rs' was misspelled as 'adpaters.rs'.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
|
||
| ## 创建Ext4镜像 | ||
| - `mod.rs`: `Ext4FileSystem::open`, superblock 预检, statfs/sync. | ||
| - `adpaters.rs`: `BlockDriver` 到 ext4_rs block interface 的适配. |
Contributor
| - [Ext4 Disk Layout](https://ext4.wiki.kernel.org/index.php/Ext4_Disk_Layout) | ||
| - [FS模块概览](README.md) | ||
| - `os/src/fs/ext4/mod.rs`: 文件系统打开, superblock 预检, statfs/sync. | ||
| - `os/src/fs/ext4/adpaters.rs`: 块设备适配层. |
Contributor
ZIYAN137
force-pushed
the
docs/refresh-design-docs
branch
from
June 29, 2026 09:11
9fbf33d to
d4a146f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
document/as the formal design documentation entry point.document/book.tomlsomdbook build documentworks with the current document layout.Notes
The docs intentionally reference SanktaOS-style concise pages, but do not copy its minimal navigation model. Comix keeps useful fine-grained navigation in
SUMMARY.md.Verification
mdbook build documentcargo doc --no-deps --target riscv64gc-unknown-none-elfgit diff --check -- document os/srcSUMMARY.mdlinks