Skip to content

docs: refresh design documentation - #269

Merged
a6d9a6m merged 1 commit into
mainfrom
docs/refresh-design-docs
Jun 30, 2026
Merged

docs: refresh design documentation#269
a6d9a6m merged 1 commit into
mainfrom
docs/refresh-design-docs

Conversation

@ZIYAN137

Copy link
Copy Markdown
Contributor

Summary

  • Rework document/ as the formal design documentation entry point.
  • Keep fine-grained mdBook navigation while making pages concise and design-focused.
  • Move API/function/field-level detail expectations to rustdoc and source comments.
  • Add current subsystem pages for architecture, boot, VFAT, shared memory, mutex, and raw spin lock.
  • Add document/book.toml so mdbook build document works with the current document layout.
  • Keep historical/unimplemented sync pages out of the main navigation.

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 document
  • cargo doc --no-deps --target riscv64gc-unknown-none-elf
  • git diff --check -- document os/src
  • checked SUMMARY.md links
  • checked stale source path references

Restructure document pages around current design, boundaries, flows, and limitations while keeping API details in rustdoc.

Add mdBook config and current subsystem pages.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread document/fs/ext4.md

## 创建Ext4镜像
- `mod.rs`: `Ext4FileSystem::open`, superblock 预检, statfs/sync.
- `adpaters.rs`: `BlockDriver` 到 ext4_rs block interface 的适配.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Typo: adpaters.rs should be adapters.rs.

- `adapters.rs`: `BlockDriver` 到 ext4_rs block interface 的适配。

Comment thread document/fs/ext4.md
- [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`: 块设备适配层.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Typo: adpaters.rs should be adapters.rs.

- `os/src/fs/ext4/adapters.rs`: 块设备适配层。

@ZIYAN137
ZIYAN137 force-pushed the docs/refresh-design-docs branch from 9fbf33d to d4a146f Compare June 29, 2026 09:11
@a6d9a6m
a6d9a6m merged commit bede99c into main Jun 30, 2026
2 checks passed
@a6d9a6m
a6d9a6m deleted the docs/refresh-design-docs branch June 30, 2026 12:34
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.

2 participants