# Summary

[Introduction](README.md)

# Asterinas NixOS

* [Getting Started](distro/README.md)
* [Popular Applications](distro/popular-applications/README.md)
    * [System Core](distro/popular-applications/system-core/README.md)
    * [Nix and NixOS Tools](distro/popular-applications/nix-and-nixos-tools/README.md)
    * [Containerization and Virtualization](distro/popular-applications/containerization-and-virtualization/README.md)
    * [Networking](distro/popular-applications/networking/README.md)
    * [Web Servers & Proxies](distro/popular-applications/web-servers-and-proxies/README.md)
    * [Databases & Middleware](distro/popular-applications/databases-and-middleware/README.md)
    * [Development Tools](distro/popular-applications/development-tools/README.md)
    * [CI/CD & DevOps](distro/popular-applications/cicd-and-devops/README.md)
    * [Monitoring & Observability](distro/popular-applications/monitoring-and-observability/README.md)
    * [Desktop Environments & Display](distro/popular-applications/desktop-environments-and-display/README.md)
    * [Web Browsers](distro/popular-applications/web-browsers/README.md)
    * [Office & Productivity](distro/popular-applications/office-and-productivity/README.md)
    * [Multimedia](distro/popular-applications/multimedia/README.md)
    * [Communication](distro/popular-applications/communication/README.md)
    * [File Management & Terminal](distro/popular-applications/file-management-and-terminal/README.md)
    * [AI & Machine Learning](distro/popular-applications/ai-and-machine-learning/README.md)

# Asterinas Kernel

* [Getting Started](kernel/README.md)
* [Advanced Build and Test Instructions](kernel/advanced-instructions.md)
    * [Intel TDX](kernel/intel-tdx.md)
* [The Framekernel Architecture](kernel/the-framekernel-architecture.md)
* [Linux Compatibility](kernel/linux-compatibility/README.md)
    * [Syscall Flag Coverage](kernel/linux-compatibility/syscall-flag-coverage/README.md)
        * [System Call Matching Language (SCML)](kernel/linux-compatibility/syscall-flag-coverage/system-call-matching-language.md)
        * [Process and thread management](kernel/linux-compatibility/syscall-flag-coverage/process-and-thread-management/README.md)
        * [Memory management](kernel/linux-compatibility/syscall-flag-coverage/memory-management/README.md)
        * [File & directory operations](kernel/linux-compatibility/syscall-flag-coverage/file-and-directory-operations/README.md)
        * [File systems & mount control](kernel/linux-compatibility/syscall-flag-coverage/file-systems-and-mount-control/README.md)
        * [File descriptor & I/O control](kernel/linux-compatibility/syscall-flag-coverage/file-descriptor-and-io-control/README.md)
        * [Inter-process communication](kernel/linux-compatibility/syscall-flag-coverage/inter-process-communication/README.md)
        * [Networking & sockets](kernel/linux-compatibility/syscall-flag-coverage/networking-and-sockets/README.md)
        * [Signals & timers](kernel/linux-compatibility/syscall-flag-coverage/signals-and-timers/README.md)
        * [Namespaces, cgroups & security](kernel/linux-compatibility/syscall-flag-coverage/namespaces-cgroups-and-security/README.md)
        * [System information & misc](kernel/linux-compatibility/syscall-flag-coverage/system-information-and-misc/README.md)
    * [File System Coverage]()
    * [Kernel Parameters](kernel/linux-compatibility/kernel-parameters.md)
* [VM-based Containers](kernel/vm-based-containers/README.md)
    * [Kata Containers](kernel/vm-based-containers/kata.md)
* [Roadmap](kernel/roadmap.md)

# Asterinas OSTD

* [An Overview of OSTD](ostd/README.md)
* [Example: Writing a Kernel in 100 Lines of Safe Rust](ostd/a-100-line-kernel.md)
* [Example: Writing a Driver in 100 Lines of Safe Rust]()
* [Soundness Analysis](ostd/soundness/README.md)
    * [What Soundness Means](ostd/soundness/what-soundness-means.md)
    * [The Sensitivity Classification](ostd/soundness/sensitivity-classification.md)
    * [Safe Physical Memory Management](ostd/soundness/safe-memory-management.md)
    * [Safe User-Kernel Interactions](ostd/soundness/safe-user-kernel-interactions.md)
    * [Safe Kernel-Peripheral Interactions](ostd/soundness/safe-kernel-peripheral-interactions.md)
    * [Safe Kernel Logic](ostd/soundness/safe-kernel-logic.md)
    * [Safe Policy Injection](ostd/soundness/safe-policy-injection.md)

# Asterinas OSDK

* [OSDK User Guide](osdk/guide/README.md)
    * [Why OSDK](osdk/guide/why.md)
    * [Creating an OS Project](osdk/guide/create-project.md)
    * [Testing or Running an OS Project](osdk/guide/run-project.md)
    * [Working in a Workspace](osdk/guide/work-in-workspace.md)
    * [Advanced Topics](osdk/guide/advanced-topics.md)
        * [Intel TDX](osdk/guide/intel-tdx.md)
* [OSDK User Reference](osdk/reference/README.md)
    * [Commands](osdk/reference/commands/README.md)
        * [cargo osdk new](osdk/reference/commands/new.md)
        * [cargo osdk build](osdk/reference/commands/build.md)
        * [cargo osdk run](osdk/reference/commands/run.md)
        * [cargo osdk test](osdk/reference/commands/test.md)
        * [cargo osdk debug](osdk/reference/commands/debug.md)
        * [cargo osdk profile](osdk/reference/commands/profile.md)
    * [Manifest](osdk/reference/manifest.md)
    * [Environment Variables](osdk/reference/environment-variables.md)

# How to Contribute

* [Before You Contribute](to-contribute/README.md)
* [Code Organization]()
* [Coding Guidelines](to-contribute/coding-guidelines/README.md)
    * [How Guidelines Are Written](to-contribute/coding-guidelines/how-guidelines-are-written.md)
    * [General Guidelines](to-contribute/coding-guidelines/general-guidelines/README.md)
    * [Rust Guidelines](to-contribute/coding-guidelines/rust-guidelines/README.md)
        * [Naming](to-contribute/coding-guidelines/rust-guidelines/naming.md)
        * [Language Items](to-contribute/coding-guidelines/rust-guidelines/language-items/README.md)
            * [Variables, Expressions, and Statements](to-contribute/coding-guidelines/rust-guidelines/language-items/variables-expressions-and-statements.md)
            * [Functions and Methods](to-contribute/coding-guidelines/rust-guidelines/language-items/functions-and-methods.md)
            * [Types and Traits](to-contribute/coding-guidelines/rust-guidelines/language-items/types-and-traits.md)
            * [Comments and Documentation](to-contribute/coding-guidelines/rust-guidelines/language-items/comments-and-documentation.md)
            * [Unsafety](to-contribute/coding-guidelines/rust-guidelines/language-items/unsafety.md)
            * [Modules and Crates](to-contribute/coding-guidelines/rust-guidelines/language-items/modules-and-crates.md)
            * [Macros and Attributes](to-contribute/coding-guidelines/rust-guidelines/language-items/macros-and-attributes.md)
        * [Select Topics](to-contribute/coding-guidelines/rust-guidelines/select-topics/README.md)
            * [Concurrency and Races](to-contribute/coding-guidelines/rust-guidelines/select-topics/concurrency-and-races.md)
            * [Defensive Programming](to-contribute/coding-guidelines/rust-guidelines/select-topics/defensive-programming.md)
            * [Error Handling](to-contribute/coding-guidelines/rust-guidelines/select-topics/error-handling.md)
            * [Logging](to-contribute/coding-guidelines/rust-guidelines/select-topics/logging.md)
            * [Memory and Resource Management](to-contribute/coding-guidelines/rust-guidelines/select-topics/memory-and-resource-management.md)
            * [Performance](to-contribute/coding-guidelines/rust-guidelines/select-topics/performance.md)
    * [Git Guidelines](to-contribute/coding-guidelines/git-guidelines.md)
    * [Testing Guidelines](to-contribute/coding-guidelines/testing-guidelines.md)
    * [Assembly Guidelines](to-contribute/coding-guidelines/asm-guidelines.md)
* [Boterinas](to-contribute/boterinas.md)
* [Version Bump](to-contribute/version-bump.md)
* [Community]()
* [Code of Conduct]()

# Request for Comments (RFCs)

* [RFC Overview](rfcs/README.md)
  * [RFC-0001: RFC Process](rfcs/0001-rfc-process.md)
  * [RFC-0002: Asterinas NixOS](rfcs/0002-asterinas-nixos.md)
* [RFC Template](rfcs/rfc-template.md)
