Samuka007/asterinas
1
0
Fork 0
mirror of https://github.com/asterinas/asterinas.git synced 2025-06-17 12:47:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix the links in the book

Browse Source
This commit is contained in:
Tate, Hongliang Tian 2024-01-26 10:19:11 +08:00
parent 844b673821
commit 29f3005e1c
4 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/src/introduction.md → docs/src/README.md
View File

50
docs/src/SUMMARY.md
View File

@ -1,6 +1,6 @@
# Summary # Summary
[Introduction](introduction.md) [Introduction](README.md)
# Asterinas Kernel # Asterinas Kernel
@ -12,37 +12,37 @@
# Asterinas Framework # 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) * [Example: Writing a Kenrel in 100 Lines of Safe Rust](framework/an-100-line-example.md)
# Asterinas OSDK # Asterinas OSDK
* [OSDK User Guide](osdk/guide/README.md) * [OSDK User Guide]()
* [Why OSDK](osdk/guide/why.md) * [Why OSDK]()
* [Creating an OS Project](osdk/guide/create-project.md) * [Creating an OS Project]()
* [Testing or Running an OS Project](osdk/guide/run-project.md) * [Testing or Running an OS Project]()
* [Working in a Workspace](osdk/guide/work-in-workspace.md) * [Working in a Workspace]()
* [OSDK User Reference](osdk/reference/README.md) * [OSDK User Reference]()
* [Commands](osdk/reference/commands/README.md) * [Commands]()
* [cargo osdk new](osdk/reference/commands/new.md) * [cargo osdk new]()
* [cargo osdk build](osdk/reference/commands/build.md) * [cargo osdk build]()
* [cargo osdk run](osdk/reference/commands/run.md) * [cargo osdk run]()
* [cargo osdk test](osdk/reference/commands/test.md) * [cargo osdk test]()
* [Manifest](osdk/reference/manifest.md) * [Manifest]()
# How to Contribute # How to Contribute
* [Before You Contribute](to-contribute/README.md) * [Before You Contribute]()
* [Code Organization](to-contribute/code-organization.md) * [Code Organization]()
* [Style Guidelines](to-contribute/style-guidelines/README.md) * [Style Guidelines]()
* [General Guidelines](to-contribute/style-guidelines/general-guidelines.md) * [General Guidelines]()
* [Rust Guidelines](to-contribute/style-guidelines/rust-guidelines.md) * [Rust Guidelines]()
* [Git Guidelines](to-contribute/style-guidelines/git-guidelines.md) * [Git Guidelines]()
* [Community](to-contribute/community.md) * [Community]()
* [Code of Conduct](to-contribute/code-of-conduct.md) * [Code of Conduct]()
# Request for Comments (RFC) # Request for Comments (RFC)
* [RFC Overview](rfcs/README.md) * [RFC Overview]()
* [RFC-0001: RFC Process](rfcs/0001-rfc-process.md) * [RFC-0001: RFC Process]()
* [RFC-0002: Operating System Development Kit (OSDK)](rfcs/0002-osdk.md) * [RFC-0002: Operating System Development Kit (OSDK)]()

6
docs/src/kernel/README.md
View File

@ -12,7 +12,7 @@ by employing Rust as its sole programming language
and limiting the use of _unsafe Rust_ and limiting the use of _unsafe Rust_
to a clearly defined and minimal Trusted Computing Base (TCB). to a clearly defined and minimal Trusted Computing Base (TCB).
This innovative approach, 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. establishes Asterinas as a more secure and dependable kernel option.
* Asterinas surpasses Linux in terms of developer friendliness. * 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, (2) leverage a purpose-built toolkit called [OSDK]() to streamline their workflows,
and (3) choose between releasing their kernel modules as open source and (3) choose between releasing their kernel modules as open source
or keeping them proprietary, 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, While the journey towards a production-grade OS kernel can be challenging,
we are steadfastly progressing towards our goal. we are steadfastly progressing towards our goal.
Currently, Asterinas only supports x86-64 VMs. 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 to make Asterinas production-ready on x86-64
for both bare-metal and VM environments. for both bare-metal and VM environments.

2
docs/src/kernel/the-framekernel-architecture.md
View File

@ -75,7 +75,7 @@ as [zero-cost abstractions](https://monomorph.is/posts/zero-cost-abstractions/).
Fortunatelly, our efforts Fortunatelly, our efforts
to design and implement an OS framework meeting these standards 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, Using this framework as a foundation,
we have developed the Asterinas Kernel; we have developed the Asterinas Kernel;
this framework also enables others to create their own framekernels, this framework also enables others to create their own framekernels,