diff --git a/docs/src/introduction.md b/docs/src/README.md similarity index 100% rename from docs/src/introduction.md rename to docs/src/README.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index a60eca4ef..47837141d 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,6 +1,6 @@ # Summary -[Introduction](introduction.md) +[Introduction](README.md) # Asterinas Kernel @@ -12,37 +12,37 @@ # Asterinas Framework -* [An Overview of Framework APIs](framework/README.md) +* [An Overview of the Framework]() * [Example: Writing a Kenrel in 100 Lines of Safe Rust](framework/an-100-line-example.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) -* [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) - * [Manifest](osdk/reference/manifest.md) +* [OSDK User Guide]() + * [Why OSDK]() + * [Creating an OS Project]() + * [Testing or Running an OS Project]() + * [Working in a Workspace]() +* [OSDK User Reference]() + * [Commands]() + * [cargo osdk new]() + * [cargo osdk build]() + * [cargo osdk run]() + * [cargo osdk test]() + * [Manifest]() # How to Contribute -* [Before You Contribute](to-contribute/README.md) -* [Code Organization](to-contribute/code-organization.md) -* [Style Guidelines](to-contribute/style-guidelines/README.md) - * [General Guidelines](to-contribute/style-guidelines/general-guidelines.md) - * [Rust Guidelines](to-contribute/style-guidelines/rust-guidelines.md) - * [Git Guidelines](to-contribute/style-guidelines/git-guidelines.md) -* [Community](to-contribute/community.md) -* [Code of Conduct](to-contribute/code-of-conduct.md) +* [Before You Contribute]() +* [Code Organization]() +* [Style Guidelines]() + * [General Guidelines]() + * [Rust Guidelines]() + * [Git Guidelines]() +* [Community]() +* [Code of Conduct]() # Request for Comments (RFC) -* [RFC Overview](rfcs/README.md) - * [RFC-0001: RFC Process](rfcs/0001-rfc-process.md) - * [RFC-0002: Operating System Development Kit (OSDK)](rfcs/0002-osdk.md) +* [RFC Overview]() + * [RFC-0001: RFC Process]() + * [RFC-0002: Operating System Development Kit (OSDK)]() diff --git a/docs/src/kernel/README.md b/docs/src/kernel/README.md index 77533f626..d7a36779f 100644 --- a/docs/src/kernel/README.md +++ b/docs/src/kernel/README.md @@ -12,7 +12,7 @@ by employing Rust as its sole programming language and limiting the use of _unsafe Rust_ to a clearly defined and minimal Trusted Computing Base (TCB). This innovative approach, -known as [the framekernel architecture](), +known as [the framekernel architecture](the-framekernel-architecture.md), establishes Asterinas as a more secure and dependable kernel option. * Asterinas surpasses Linux in terms of developer friendliness. @@ -21,12 +21,12 @@ It empowers kernel developers to (2) leverage a purpose-built toolkit called [OSDK]() to streamline their workflows, and (3) choose between releasing their kernel modules as open source or keeping them proprietary, -thanks to the flexibility offered by [MPL](). +thanks to the flexibility offered by [MPL](../). While the journey towards a production-grade OS kernel can be challenging, we are steadfastly progressing towards our goal. Currently, Asterinas only supports x86-64 VMs. -However, [our aim for 2024]() is +However, [our aim for 2024](roadmap.md) is to make Asterinas production-ready on x86-64 for both bare-metal and VM environments. diff --git a/docs/src/kernel/the-framekernel-architecture.md b/docs/src/kernel/the-framekernel-architecture.md index 151605d8c..07fb01776 100644 --- a/docs/src/kernel/the-framekernel-architecture.md +++ b/docs/src/kernel/the-framekernel-architecture.md @@ -75,7 +75,7 @@ as [zero-cost abstractions](https://monomorph.is/posts/zero-cost-abstractions/). Fortunatelly, our efforts to design and implement an OS framework meeting these standards -have borne fruit in the form of the [Asterinas Framework](). +have borne fruit in the form of the [Asterinas Framework](../framework/). Using this framework as a foundation, we have developed the Asterinas Kernel; this framework also enables others to create their own framekernels,