rust-osdev / rust-osdev/bootloader
Advanced Documentation
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.7k
- Forks
- 240
- PR merge metrics
- No merged PRs in 30d
Description
Currently we only provide some minimal build instructions in the Readme. We should also document advanced patterns such as:
- Creating a higher half kernel
-
Chainloading with GRUB (see #49)Completed in #66
I think the best approach for now is to just create a doc folder with markdown files in it and link it from the Readme.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing build instructions in the README and the completed GRUB documentation referenced by #49 and #66. Add Markdown documentation in a new doc folder covering creating a higher half kernel, then link the new documentation from the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100