Skip to content

Add Lain tutorial docs #3484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+602 −16
Draft

Add Lain tutorial docs #3484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4d44c3
Add Lain tutorial docs
domenukk Nov 11, 2025
a482a46
y u no link
domenukk Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/workflows/build_and_test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,15 @@ jobs:
run: ./scripts/check_for_blobs.sh
- name: Build libafl debug
run: cargo build -p libafl
- name: Build tutorial fuzzer
run: (cd fuzzers/baby/tutorial && cargo build)
- name: Test the book (Linux)
# TODO: fix books test fail with updated windows-rs
if: runner.os == 'Linux'
run: cd docs && mdbook test -L ../target/debug/deps
run: cd docs && mdbook test -L ../fuzzers/baby/tutorial/debug/deps
- name: Test the book (MacOS)
if: runner.os == 'MacOS'
run: cd docs && mdbook test -L ../target/debug/deps $(python3-config --ldflags | cut -d ' ' -f1)
run: cd docs && mdbook test -L ../fuzzers/baby/tutorial/debug/deps $(python3-config --ldflags | cut -d ' ' -f1)
- name: Build individual libafl book examples (linux)
if: runner.os == 'Linux'
run: cd docs/listings/baby_fuzzer/ && just build-all
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This project contains the out-of-source LibAFL documentation as a book.

Here you can find tutorials, examples, and detailed explanations.
Here you can find the [LibAFL tutorial](./src/tutorial/tutorial.md), examples, and detailed explanations.

For the API documentation instead, run `cargo doc` in the LibAFl root folder.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/getting_started/crates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Currently, the supported flags are:
This is a library that provides utils to wrap compilers and create source-level fuzzers.

At the moment, only the Clang compiler is supported.
To understand it deeper, look through the tutorials and examples.
To understand it deeper, look through the [tutorial](../tutorial/tutorial.md) and examples.

### [`libafl_frida`](https://github.com/AFLplusplus/LibAFL/tree/main/crates/libafl_frida)

Expand Down
10 changes: 4 additions & 6 deletions docs/src/tutorial/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Introduction

> ## Under Construction!
>
> This section is under construction.
> Please check back later (or open a PR)
>
> In the meantime, find the final Lain-based fuzzer in [the fuzzers folder](https://github.com/AFLplusplus/LibAFL/tree/main/fuzzers/baby/tutorial)
This chapter will walk you through the creation of a fuzzer, step by step.
If you are new to LibAFL, this is the right place to start.

[Let's start with the first tutorial!](./tutorial.md)
Loading
Loading