leanprover / leanprover/verso

Save Lean example contexts for later

Open
#42 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lean
Stars
384
Forks
124
Avg merge
22h 28m
Merged PRs (30d)
10

Description

Right now, Lean example contexts exist in an ephemeral environment extension that contains an environment. This is fine if all the examples exist in a single file, but it doesn't work well if one wants to e.g. have a blog post or book chapter that builds on another one.

Serializing the saved environment to a .olean isn't really a good idea. So I plan to add an option to save the syntax of the commands that gave rise to the environment and export them for replay while rendering the other environment.

This is not great for complex running examples (like in Functional Programming in Lean), though. For that, we need a better solution. It could look like writing the example in an examples file with named commands, as the book's text is now, but extracting them into Verso via metaprogramming rather than regexps. This needs further thought.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue describes saving Lean command syntax for replay across rendered environments, with a separate need for complex running examples. Read the example-context environment extension and rendering entry points to understand how contexts are currently stored and consumed. The issue says the design needs further thought; done would require a decided approach for replaying saved commands across documents.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.