This is for #383 but we will also hopefully touch on other documentation PRs as we work on this.
Order
[x] The examples should be reordered from least to most complicated, finishing with a full dist example. Some of the examples are already appropriately placed, but some are totally wrong.
[x] Integer example
[x] String argument example
[x] String return example (possibly more than one, owned, unowned, static, etc)
[x] Pointers
[x] Opaque (objects)
[x] Opaques (malloc/free, buffers, strdup)
[x] Arrays
[x] Pointers as arrays
[x] Unix GUI (libnotify)
[x] Windows GUI (MessageBoxW)
[x] FFI::C
[x] Record
[x] Buffers (FFI::Platypus::Buffer)
[x] Window (FFI::Platypus::Buffer::window)
[x] OO opaque (libarchive)
[x] OO integer (unix open)
[x] variadic functions (libcurl)
[x] Callback
[x] Bundle code
Format
[x] New format: each example should include these sections (some are optional):
C API (for external libraries) this can be a link to the appropriate documentation
C Source (for bundled examples)
Perl Source
Execute
Discussion
Pictures
[x] GUI stuff should have images in the HTML. This should live in the Execute section. In think there are only two examples so far:
Big Example Refresh PR
This is for #383 but we will also hopefully touch on other documentation PRs as we work on this.
Order
Format
[x] New format: each example should include these sections (some are optional):
Pictures
Rework stuff removed in these refactors
Testing