This is an automated email from the ASF dual-hosted git repository.
zfc pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-teaclave.git
The following commit(s) were added to refs/heads/main by this push:
new ec8e0486 docs: add website-toc for website display.
ec8e0486 is described below
commit ec8e0486f694080d5a07c13cb5a5a78c9f3f5021
Author: Zhaofeng Chen <[email protected]>
AuthorDate: Fri Jul 18 03:33:27 2025 +0000
docs: add website-toc for website display.
---
crates/README.md | 15 +++++++++++----
sgx/README.md | 16 ++++++++++++----
trustzone/README.md | 19 +++++++++++++++----
website-toc.md | 21 +++++++++++++++++++++
4 files changed, 59 insertions(+), 12 deletions(-)
diff --git a/crates/README.md b/crates/README.md
index 5c6747c8..5d63355e 100644
--- a/crates/README.md
+++ b/crates/README.md
@@ -1,11 +1,18 @@
-# Teaclave Crates Directory
+# Teaclave Crates
-This directory contains Rust crates developed by Teaclave contributors. These
crates are designed to be architecture-agnostic, enabling shared code across
different Trusted Execution Environment (TEE) hardware.
+Teaclave Crates contains Rust crates developed by Teaclave contributors.
+These crates are designed to be architecture-agnostic, enabling shared code
+across different Trusted Execution Environment (TEE) hardware.
## Purpose
-Teaclave enables the development of Trusted Applications across various TEE
hardware. Many use cases might have architecture-independent shared code,
agnostic to the underlying architecture. This directory serves as a repository
for such Rust crates.
+Teaclave enables the development of Trusted Applications across various TEE
+hardware. Many use cases might have architecture-independent shared code,
+agnostic to the underlying architecture. This directory serves as a
+repository for such Rust crates.
## Contribution
-We welcome contributions from the community. If you have a crate that fits the
purpose of this directory, please refer to our Contributing Guide for more
information.
+We welcome contributions from the community. If you have a crate that fits
+the purpose of this directory, please refer to our Contributing Guide for
+more information.
diff --git a/sgx/README.md b/sgx/README.md
index 9b8d4e1e..ce60bce6 100644
--- a/sgx/README.md
+++ b/sgx/README.md
@@ -1,9 +1,17 @@
# Showcase of SGX Enclaves
-The Teaclave SGX SDK enables developers to build enclaves in Rust for Intel®
Software Guard Extensions (SGX), offering a memory-safe and enclave-isolated
execution environment.
+The Teaclave SGX SDK enables developers to build enclaves in Rust for
+Intel® Software Guard Extensions (SGX), offering a memory-safe and
+enclave-isolated execution environment.
-With full support for rust-std and integration with the Rust ecosystem,
developers can implement complex enclave logic in a safe and ergonomic way,
protecting sensitive data in practical deployment scenarios.
+With full support for rust-std and integration with the Rust ecosystem,
+developers can implement complex enclave logic in a safe and ergonomic way,
+protecting sensitive data in practical deployment scenarios.
-This directory presents a collection of advanced reference implementations
using the Teaclave SGX SDK, covering real-world use cases, showcasing how Rust
and SGX together can power secure and trustworthy systems.
+This directory presents a collection of advanced reference implementations
+using the Teaclave SGX SDK, covering real-world use cases, showcasing how
+Rust and SGX together can power secure and trustworthy systems.
-We welcome contributions from developers building with the Teaclave SGX SDK,
especially sharing minimal MVPs that highlight real use cases with the
community.
\ No newline at end of file
+We welcome contributions from developers building with the Teaclave SGX
+SDK, especially sharing minimal MVPs that highlight real use cases with the
+community.
diff --git a/trustzone/README.md b/trustzone/README.md
index d86d7dca..dd48efc1 100644
--- a/trustzone/README.md
+++ b/trustzone/README.md
@@ -1,9 +1,20 @@
# Showcase of Trusted Applications in TrustZone
-The Teaclave TrustZone SDK enables developers to build Trusted Applications
(TAs) in Rust, providing a memory-safe and secure execution environment. Many
of the examples in the SDK repository are adapted from OP-TEE's original
C-based examples, demonstrating fundamental security primitives.
+The Teaclave TrustZone SDK enables developers to build Trusted Applications
+(TAs) in Rust, providing a memory-safe and secure execution environment.
+Many of the examples in the SDK repository are adapted from OP-TEE's
+original C-based examples, demonstrating fundamental security primitives.
-With `rust-std` support and access to the broader Rust ecosystem, developers
can now build more sophisticated logic in TAs, enabling robust protection of
sensitive data in real-world applications.
+With `rust-std` support and access to the broader Rust ecosystem,
+developers can now build more sophisticated logic in TAs, enabling robust
+protection of sensitive data in real-world applications.
-This directory presents a curated collection of advanced reference
implementations using the Teaclave TrustZone SDK. These examples span a variety
of use cases, such as digital wallets and Web3 DePIN scenarios, showcasing how
Rust and TrustZone together can secure critical components in decentralized
systems.
+This directory presents a curated collection of advanced reference
+implementations using the Teaclave TrustZone SDK. These examples span a
+variety of use cases, such as digital wallets and Web3 DePIN scenarios,
+showcasing how Rust and TrustZone together can secure critical components
+in decentralized systems.
-We welcome contributions from developers using the Teaclave TrustZone SDK,
especially minimal MVPs that demonstrate real use cases and share new Trusted
Application examples with the community.
\ No newline at end of file
+We welcome contributions from developers using the Teaclave TrustZone SDK,
+especially minimal MVPs that demonstrate real use cases and share new
+Trusted Application examples with the community
diff --git a/website-toc.md b/website-toc.md
new file mode 100644
index 00000000..cce6e9e8
--- /dev/null
+++ b/website-toc.md
@@ -0,0 +1,21 @@
+# Teaclave: Empowering Memory-Safe Trusted Applications
+
+Welcome to the Teaclave ecosystem. Teaclave empowers developers to build
+**memory-safe** Trusted Applications
+across diverse **confidential computing platforms**, including Intel SGX
+and Arm TrustZone.
+
+For SDK integration and setup instructions, please refer to the
+documentation in each corresponding SDK repository.
+
+The content below serves as a table of contents for documentation in the
+Teaclave repository.
+
+## Teaclave TrustZone Ecosystem
+- [Showcase of Trusted Applications in TrustZone](trustzone/README.md)
+
+## Teaclave SGX Ecosystem
+- [Showcase of SGX Enclaves](sgx/README.md)
+
+## Teaclave Crates
+- [Teaclave Crates](crates/README.md)
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
