Repository navigation
Home
Zikithezikit edited this page Mar 2, 2026
·
2 revisions
Welcome to the rust-kernel project documentation. This wiki provides comprehensive guides for developers working on this bare-metal x86_64 operating system kernel written in Rust.
- Developer Onboarding - Get started with development
- API Usage - Detailed API documentation
- Feature Addition - Guide for adding new features
- Developer Onboarding - Comprehensive development guide
- API Usage - Public API documentation
- Feature Addition - Step-by-step feature development
- README - Main project information
- CHANGELOG - Version history
- CONTRIBUTING - Contribution guidelines
If you need assistance:
- Check the Developer Onboarding guide
- Review the API Usage documentation
- Look at existing code examples
- Check the Troubleshooting section
- Ask questions in the project discussions
- Context switching
- Scheduler (round-robin)
- Timer-based preemption
- TSS (Task State Segment)
- System calls (13 implemented)
- VFS inode interface
- Initramfs and Tmpfs filesystems
- Task structures with state management
- Linux-style ID allocator
Next Priorities:
- Fix VMM page fault handling
- Replace bump allocator with slab allocator
- Complete syscall implementation
- Add process isolation
This project is licensed under the MIT License - see the LICENSE file for details.
- Developer Onboarding - Getting started
- API Usage - How to use the APIs
- Feature Addition - Adding new features
- Error Handling - Unified error system
- Memory Management - Memory APIs
- Task Management - Process APIs
- VFS APIs - File system APIs
- Build Commands - Available make targets
- Testing - How to run tests
- Debugging - Debugging techniques
- Code Structure - How the code is organized
- Module Responsibilities - What each module does
- Key Concepts - Important architectural concepts
This documentation is for the current development version. For specific version documentation, check the Releases page.
- Rust Language Book - Rust programming language
- x86_64 Crate Documentation - x86_64 CPU abstractions
- Writing an OS in Rust - Excellent OS development tutorial
- Linux Kernel Documentation - Reference for Linux architecture
Last Updated: March 2026 Documentation Version: 1.0