Skip to content

Write a stdlib tutorial #3045

Description

@JacquesCarette

Various parts of stdlib involve non-trivial lore to use properly -- and people without that lore complain (unjustly) about the design. But without documentation to point to, it is hard to deflect these complaints.

Certainly

  1. using the 'deeply nested' records of the Algebra hierarchy,
  2. creating new Reasoning instances

deserve some air time.

We have, in a sense, some tutorials already: they are buried in the READMEs! But there does not seem to be much awareness of them. So the technical means of writing such tutorial(s) may well involve those READMEs. Already some table-of-contents page for the existing material would help.

[Meta note: maybe the enumeration above should be a task list, and could be extended by others as they encounter such items.]

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions