Commit 090626a5 authored by Dan Robertson's avatar Dan Robertson

Massive mdbook update

 - Update to latest mdbook
   - Switch to using book.toml
   - No empty links are allowed anymore. Comment out all empty links in
     SUMMARY.md
 - Add theme
   - Add favicon.png
parent 26679a19
{
"title": "The Redox Operating System",
"description": "This book carefully describes the design, implementation, direction, and structure of Redox, the operating system.",
"author": "Ticki"
}
[book]
title = "The Redox Operating System"
author = "The RedoxOS Developers"
description = "This book carefully describes the design, implementation, direction, and structure of Redox, the operating system."
multilingual = false
src = "src"
[output.html]
theme = "./theme"
......@@ -3,18 +3,18 @@
- [Overview](./overview/welcome.md)
- [What Redox is](./overview/what_redox_is.md)
- [The Redox community](./overview/community.md)
- [Side projects](./overview/side_projects.md)
- [Projects maintainers](./overview/maintainers.md)
- [Side projects](./overview/side_projects.md)
- [Projects maintainers](./overview/maintainers.md)
- [Introduction]()
- [Introduction](./introduction/index.md)
- [What is Redox?](./introduction/what_is_redox.md)
- [Why Redox?](./introduction/why_redox.md)
- [Why Free Software?](./introduction/why_free_software.md)
- [Why Rust?](./introduction/why_rust.md)
- [Heartbleed: A case study]()
[//]: # ( - [Heartbleed: A case study]())
- [Unsafes](./introduction/unsafes.md)
- [How Redox compares to other operating systems](./introduction/how_redox_compares_to_other_operating_systems.md)
- [The target of Redox]()
[//]: # ( - [The target of Redox]())
- [Will Redox replace Linux?](./introduction/will_redox_replace_linux.md)
- [About this Book](./introduction/about_this_book.md)
......@@ -30,23 +30,23 @@
- [Exploring Redox](./explore/explore.md)
- [Boot Process](./explore/boot_process.md)
- [Shell](./explore/shell.md)
- [Utilities]()
[//]: # ( - [Utilities]())
- [GUI](./explore/gui.md)
- [The design](./design/design.md)
- [Components](./design/components.md)
- [URLs, schemes and resources](./design/urls_schemes_resources.md)
- [URLs](./design/url/urls.md)
- [Aren't they weakly typed?]()
- [Aren't they confusing?]()
[//]: # ( - [Aren't they weakly typed?]())
[//]: # ( - [Aren't they confusing?]())
- [How it works under the hood](./design/url/how_it_works.md)
- [Schemes](./design/scheme/schemes.md)
- [The root scheme](./design/scheme/the_root_scheme.md)
- [Writing your own scheme]()
- [Using schemes efficiently]()
[//]: # ( - [Writing your own scheme]())
[//]: # ( - [Using schemes efficiently]())
- [Resources](./design/resource/resources.md)
- [Socket-like]()
- [File-like]()
[//]: # ( - [Socket-like]())
[//]: # ( - [File-like]())
- [Stitching it all together](./design/url_scheme_resource/stiching_it_all_together.md)
- ["Everything is a URL"](./design/url_scheme_resource/everything_is_a_url.md)
- [An example](./design/url_scheme_resource/example.md)
......@@ -54,96 +54,90 @@
- [Microkernels](./design/kernel/microkernels.md)
- [Advantages of microkernels](./design/kernel/advantages.md)
- [Disadvantages of microkernels](./design/kernel/disadvantages.md)
- [Performance of microkernels]()
- [Syscalls]()
- [Linux compatibility]()
- [Scheduling]()
- [Memory management]()
- [Drivers]()
- [Trade-offs]()
- [Safety and performance]()
- [Simplicity and expressiveness]()
[//]: # ( - [Performance of microkernels]())
[//]: # ( - [Syscalls]())
[//]: # ( - [Linux compatibility]())
- [Scheduling](./design/scheduling)
- [Memory management](./design/memory)
- [Drivers](./design/drivers)
[//]: # ( - [Trade-offs]())
[//]: # ( - [Safety and performance]())
[//]: # ( - [Simplicity and expressiveness]())
- [Programs and Libraries](./design/programs_libraries.md)
- [Coreutils](./design/coreutils/coreutils.md)
- [Fail, fail, and fail]()
- [Simplicty and minimalism]()
- [Supplement utilities]()
[//]: # ( - [Fail, fail, and fail]())
[//]: # ( - [Simplicty and minimalism]())
- [Supplement utilities](./design/coreutils/supplement/index.md)
- [Binutils](./design/coreutils/supplement/binutils.md)
- [Extrautils](./design/coreutils/supplement/extrautils.md)
- [ZFS]()
- [What ZFS is]()
- [The Uberblock]()
- [RAID]()
- [The VDev tree]()
- [Orbital]()
- [What Orbital is]()
- [Orbclient]()
- [Opening a window]()
- [Extras]()
- [OrbTK]()
- [Orbutils]()
- [pkgutils]()
- [Sodium]()
- [What it is]()
- [Understanding the design]()
- [Using Sodium efficiently]()
- [Development in user space]()
- [What user space is]()
- [Writing an application for Redox]()
- [Platform independence]()
- [What is available and what is not]()
- [Using schemes]()
- [Using Orbital]()
[//]: # ( - [Orbital]())
[//]: # ( - [What Orbital is]())
[//]: # ( - [Orbclient]())
[//]: # ( - [Opening a window]())
[//]: # ( - [Extras]())
[//]: # ( - [OrbTK]())
[//]: # ( - [Orbutils]())
[//]: # ( - [pkgutils]())
[//]: # ( - [Sodium]())
[//]: # ( - [What it is]())
[//]: # ( - [Understanding the design]())
[//]: # ( - [Using Sodium efficiently]())
- [Development in user space](./userspace/index.md)
[//]: # ( - [What user space is]())
- [Writing an application for Redox](./userspace/writing_application/index.md)
[//]: # ( - [Platform independence]())
[//]: # ( - [What is available and what is not]())
[//]: # ( - [Using schemes]())
[//]: # ( - [Using Orbital]())
- [Compiling your program](./userspace/writing_application/compiling_program.md)
- [A full example]()
- [Porting a program]()
- [Remove dependencies]()
- [Cross-compiling]()
[//]: # ( - [A full example]())
[//]: # ( - [Porting a program]())
[//]: # ( - [Remove dependencies]())
[//]: # ( - [Cross-compiling]())
- [Ion](./userspace/ion/ion.md)
- [What Ion is](./userspace/ion/what_ion_is.md)
- [The Manual](./userspace/ion/the_manual.md)
- [Contributing](./contributing/contributing.md)
- [Communication]()
- [Communication](./contributing/communication/index.md)
- [Chat](./contributing/communication/chat.md)
- [Reddit](./contributing/communication/reddit.md)
- [Direct contributions]()
- [Direct contributions](./contributing/direct_contributions/index.md)
- [Low hanging fruit](./contributing/direct_contributions/low_hanging_fruit.md)
- [GitHub issues](./contributing/direct_contributions/github_issues.md)
- [How to do a bug report correctly](./contributing/direct_contributions/creating_proper_bug_reports.md)
- [Pull requests](./contributing/direct_contributions/pull_requests.md)
- [How to do a pull request properly](./contributing/direct_contributions/creating_proper_pull_requests.md)
- [Indirect contributions]()
[//]: # (TODO FIX THIS)
[//]: # ( - [Indirect contributions]())
- [Community](./contributing/indirect_contributions/community.md)
- [Porting your programs to Redox]()
[//]: # ( - [Porting your programs to Redox]())
- [Best practices and guidelines](./contributing/best_practices/overview.md)
- [Documentation]()
[//]: # (TODO FIX THIS)
[//]: # ( - [Documentation]())
- [Literate programming](./contributing/documentation/literate_programming.md)
- [Writing docs correcty (TM)](./contributing/documentation/writing_docs_correctly.md)
- [Marking code]()
- [XXX]()
- [TODO]()
- [FIXME]()
[//]: # ( - [Marking code]())
[//]: # ( - [XXX]())
[//]: # ( - [TODO]())
[//]: # ( - [FIXME]())
- [Style](./contributing/best_practices/style.md)
- [Rusting properly](./contributing/best_practices/rusting_properly.md)
- [Writing fast Rust]()
- [Avoiding heap allocations]()
- [Exiting a program]()
[//]: # ( - [Writing fast Rust]())
[//]: # ( - [Avoiding heap allocations]())
[//]: # ( - [Exiting a program]())
- [Avoiding panics in the kernel](./contributing/best_practices/avoiding_kernel_panics.md)
- [Tests]()
- [Tests in the kernel]()
- [Logging and assertions]()
[//]: # ( - [Tests]())
[//]: # ( - [Tests in the kernel]())
[//]: # ( - [Logging and assertions]())
- [Git](./contributing/best_practices/git.md)
- [Understanding the codebase]()
- [Kernel]()
- [Environment]()
- [Fun]()
- [Setting up a Redox desktop]()
- [Customizing Redox]()
- [The future]()
- [What is done and what is not]()
- [Goals]()
- [Redox's target]()
[//]: # (- [Understanding the codebase]())
[//]: # ( - [Kernel]())
[//]: # ( - [Environment]())
[//]: # (- [Fun]())
[//]: # ( - [Setting up a Redox desktop]())
[//]: # ( - [Customizing Redox]())
[//]: # (- [The future]())
[//]: # ( - [What is done and what is not]())
[//]: # ( - [Goals]())
[//]: # ( - [Redox's target]())
Chat
====
The quickest and most open way to communicate with the Redox team is on our chat server, powered with [Mattermost](https://about.mattermost.com/).
The quickest and most open way to communicate with the Redox team is on our chat server, powered with [Mattermost](https://about.mattermost.com/).
Currently, the only way to join it is by sending an email to [info@redox-os.org](mailto:info@redox-os.org), which might take a little while, since it's not automated. We're currently working on an easier way to do this, but this is the most convenient way right now.
The Redox team is also available on IRC, on the `#redox` and `#rust` channels, but be advertised that we are less present on IRC than the Chat.
# Development in user space
# Writing an application for Redox
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment