From ae2b7fa49541e2c838f14d969828cf7957dd2057 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 11 Feb 2023 17:32:39 +0200 Subject: docs: add meeting minutes Sponsored-by: author --- blog/2023/02/11/planning.mdwn | 46 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 blog/2023/02/11/planning.mdwn diff --git a/blog/2023/02/11/planning.mdwn b/blog/2023/02/11/planning.mdwn new file mode 100644 index 0000000..a6a524c --- /dev/null +++ b/blog/2023/02/11/planning.mdwn @@ -0,0 +1,46 @@ +[[!meta title="Iteration planning: February 11-23"]] +[[!meta date="2023-02-11 15:50:00 +0000"]] +[[!tag meeting]] + +# Notes + +We decided to not follow the usual meeting structure and instead only +discussed how to refactor the Subplot code base. + +We've reached a stage where the next thing to do is to replace the +Pandoc (or `pandoc_ast`) representation of a parsed Markdown document +with one of our own. We don't like the Pandoc one for the things we +want to do, and would prefer a more malleable one. In addition, the +Pandoc one has changed in incompatible ways before, making it harder +for us to use it. + +We discussed what we want from such a representation and came up with +a plan. For this iteration: + +* Daniel will refactor the `Document` methods to avoid requiring a + mutable reference to self, when possible. +* Lars will refactor `Document` to drop the `markdowns` fields and the + `Document::sources` method to get the information from the document + metadata instead. +* Lars will change Subplot to drop direct support for generating PDF. + We decided that for now, we only care about HTML output. We may add + PDF support back later, but it'll be easier to not need have that + while we are redoing document parsing. In any case, we've verified + that producing a reasonable PDF with Pandoc from the HTML output is + feasible. +* Lars will drop `pandoc_ast` as a dependency in favor of + `pulldown_cmark`, and a custom representation of a parsed Markdown + document. Lars will probably use a lightweight abstraction for HTML, + and rewrite the `pandoc_ast::MutVisitor` use to query that instead. +* Lars will drop the `Markdown::set_metatdata` method and instead give + the `YamlMetadata` directly to `Markdown::to_json`. From the + caller's point of view, there's no need to have two methods for + this. Or possibly Lars will just drop both methods, if they're not + needed for HTML generation. + + + +# Meeting participants + +- Daniel Silverstone +- Lars Wirzenius -- cgit v1.2.1