Skip to content
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.

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

documentation overhaul plan #554

Open
1 task
zapashcanon opened this issue Mar 18, 2025 · 0 comments
Open
1 task

documentation overhaul plan #554

zapashcanon opened this issue Mar 18, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@zapashcanon
Copy link
Member

zapashcanon commented Mar 18, 2025

General Stuff

Tutorials (learning) How-To Guides (goals) Explanation (understanding) Information (reference)
  • installation (from static binary, opam, source)
  • General explanation
  • History of the project
  • Spelling and pronunciation
  • list of supported Wasm proposals
  • CHANGELOG
  • LICENSE
  • Authors and contributors
  • Fundings

Symbolic Execution Engine

Tutorials (learning) How-To Guides (goals) Explanation (understanding) Information (reference)
  • Comparison with others engines/languages (KLEE, Wasm ones...)
  • Talks
  • Papers
  • List of subcommands
  • Supported languages
  • Present all exposed functions for symbols etc.

Bug-Finding, Testing & Pen-testing

Tutorials (learning) How-To Guides (goals) Explanation (understanding) Information (reference)
  • Examples of bug finding (programming error, assertion failure, differential testing)
  • How-To make it faster?
  • Compare to fuzzers and abstract interpretation
  • Bugs found by Owi

Solver-Aided Programming

Tutorials (learning) How-To Guides (goals) Explanation (understanding) Information (reference)
  • Examples of problems solving (polynomial, maze, dobble, music generation, graphs generation...)
  • How-To make it faster?
  • Comparison to Rosette, Prolog and other tools

Test-Case Generation

Tutorials (learning) How-To Guides (goals) Explanation (understanding) Information (reference)

Verification & Proof of Programs

Tutorials (learning) How-To Guides (goals) Explanation (understanding) Information (reference)
  • Comparison with deductive verification and abstract interpretation

Wasm Toolkit

Tutorials (learning) How-To Guides (goals) Explanation (understanding) Information (reference)
  • Comparison with other tools (Binaryen, wabt)
  • Talks
  • Papers
  • list of subcommands

Public OCaml API

Tutorials (learning) How-To Guides (goals) Explanation (understanding) Information (reference)
  • How-To define custom functions in OCaml
  • Talks
  • Papers
  • odoc generated documentation

Private OCaml API, Sources & Hacking

Tutorials (learning) How-To Guides (goals) Explanation (understanding) Information (reference)
  • development set-up
  • Talks
  • Papers
  • odoc generated documentation

Other ideas

  • what about the fuzzer?
@zapashcanon zapashcanon added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants