From 381aa3c052a6faa1d35f5f6fe1119763b59cc478 Mon Sep 17 00:00:00 2001 From: Andrea Fioraldi Date: Wed, 7 Apr 2021 16:39:51 +0200 Subject: [PATCH] meta --- docs/src/SUMMARY.md | 9 ++++++++- docs/src/design/architecture.md | 3 +++ docs/src/{ => design}/core_concepts.md | 0 docs/src/design/design.md | 3 +++ docs/src/design/state.md | 1 + docs/src/medatata/de_serialization.md | 1 + docs/src/medatata/definition.md | 1 + docs/src/medatata/metadata.md | 1 + docs/src/medatata/usage.md | 1 + 9 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 docs/src/design/architecture.md rename docs/src/{ => design}/core_concepts.md (100%) create mode 100644 docs/src/design/design.md create mode 100644 docs/src/design/state.md create mode 100644 docs/src/medatata/de_serialization.md create mode 100644 docs/src/medatata/definition.md create mode 100644 docs/src/medatata/metadata.md create mode 100644 docs/src/medatata/usage.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 2e0dadb941..5ab55fd332 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -11,5 +11,12 @@ - [Baby Fuzzer](./baby_fuzzer.md) -- [Core Concepts](./core_concepts.md) +- [Design](./design/design.md) + - [Core Concepts](./design/core_concepts.md) + - [Architecture](./design/architecture.md) + - [The State](./design/state.md) +- [Understanding Metadata](./medatata/metadata.md) + - [Definition](./medatata/definition.md) + - [(De)Serialization](./medatata/de_serialization.md) + - [Usage](./medatata/usage.md) diff --git a/docs/src/design/architecture.md b/docs/src/design/architecture.md new file mode 100644 index 0000000000..886c187e10 --- /dev/null +++ b/docs/src/design/architecture.md @@ -0,0 +1,3 @@ +# Architecture + +The LibAFL architecture diff --git a/docs/src/core_concepts.md b/docs/src/design/core_concepts.md similarity index 100% rename from docs/src/core_concepts.md rename to docs/src/design/core_concepts.md diff --git a/docs/src/design/design.md b/docs/src/design/design.md new file mode 100644 index 0000000000..3650272973 --- /dev/null +++ b/docs/src/design/design.md @@ -0,0 +1,3 @@ +# Design + +In this chapter, we introduce the abstract Core Concepts behind LibAFL, we then discuss how we designed the library to take into account these concepts while allowing code reuse and extensibility. diff --git a/docs/src/design/state.md b/docs/src/design/state.md new file mode 100644 index 0000000000..a898f3c21a --- /dev/null +++ b/docs/src/design/state.md @@ -0,0 +1 @@ +# The State diff --git a/docs/src/medatata/de_serialization.md b/docs/src/medatata/de_serialization.md new file mode 100644 index 0000000000..fabf103865 --- /dev/null +++ b/docs/src/medatata/de_serialization.md @@ -0,0 +1 @@ +# (De)Serialization diff --git a/docs/src/medatata/definition.md b/docs/src/medatata/definition.md new file mode 100644 index 0000000000..9cf6ae572d --- /dev/null +++ b/docs/src/medatata/definition.md @@ -0,0 +1 @@ +# Definition diff --git a/docs/src/medatata/metadata.md b/docs/src/medatata/metadata.md new file mode 100644 index 0000000000..dfcaceb2b9 --- /dev/null +++ b/docs/src/medatata/metadata.md @@ -0,0 +1 @@ +# Understanding Metadata diff --git a/docs/src/medatata/usage.md b/docs/src/medatata/usage.md new file mode 100644 index 0000000000..8f04b05adb --- /dev/null +++ b/docs/src/medatata/usage.md @@ -0,0 +1 @@ +# Usage