Skip to content

documentation overhaul plan #554

@redianthus

Description

@redianthus

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?

TODO

  • list of projects/people using Owi

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions