Skip to content

Update documentation #38

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

Merged
merged 5 commits into from
May 2, 2024
Merged

Update documentation #38

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
65a5381
restructure documentation
andreashappe Apr 30, 2024
c41468a
fix image path
andreashappe Apr 30, 2024
6b1900d
typo
andreashappe Apr 30, 2024
228015a
Update linux_privesc.md
andreashappe Apr 30, 2024
4d24310
Update linux_privesc.md
andreashappe Apr 30, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
typo
  • Loading branch information
@andreashappe
andreashappe committed Apr 30, 2024
commit 6b1900db3b919e5ad61485bb9d98c6990c8d1fbf
4 changes: 2 additions & 2 deletions docs/dev_quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ So you want to create your own LLM hacking agent? We've got you covered and take

Let's start with some basic concepts:

- A (usecase)[docs/use_case.md] is our basic abstraction for an agent. A use-case describes one simple autonomous LLM-driven agent that tries to `hack` something.
- (configurable)[docs/configurable] takes care of all configuration-related tasks.
- A [usecase](docs/use_case.md) is our basic abstraction for an agent. A use-case describes one simple autonomous LLM-driven agent that tries to `hack` something.
- [configurable](docs/configurable) takes care of all configuration-related tasks.

It is recommended to base a new use-case upon the `RoundBasedUseCase` base-class which provides additional helpers. Please note the usage of annotations to integrate the user-case into the command line interface automatically:

Expand Down