diff options
author | Daniel Silverstone <dsilvers+gitlab@digital-scurf.org> | 2023-03-21 08:40:07 +0000 |
---|---|---|
committer | Daniel Silverstone <dsilvers+gitlab@digital-scurf.org> | 2023-03-21 08:40:07 +0000 |
commit | ac045b32017cf4bb2cd25c2c711e68b2e2d74261 (patch) | |
tree | b7d7ffded6fedecd3284c2a52a5b9bdb24be4169 | |
parent | 70bdcb86322f8780141fe1f24f721caca514c284 (diff) | |
parent | 826a66b131f5e1245bc16e2b2f74ae88b00ee481 (diff) | |
download | subplot-ac045b32017cf4bb2cd25c2c711e68b2e2d74261.tar.gz |
Merge branch 'liw/decisions' into 'main'
document decisions
See merge request subplot/subplot!316
-rw-r--r-- | DECISIONS.md | 35 |
1 files changed, 24 insertions, 11 deletions
diff --git a/DECISIONS.md b/DECISIONS.md index bc6b766..0f12fc9 100644 --- a/DECISIONS.md +++ b/DECISIONS.md @@ -13,26 +13,39 @@ Each decision should have its own heading. Newest decision should come first. Updated or overturned decisions should have their section updated to note their status, without moving them. -## Threshold for refactoring +## Output format for `docgen` -Date: 2022-10-23 +Date: 2023-03-21 -What: Instead of trying to do a whole code base tidy up, we'll -continuously do smaller refactoring changes when we see something that -needs improvement. +What: `subplot docgen` will only support HTML as the output format. We +no longer support PDF. + +Why: We want to drop support of Pandoc for parsing markdown input +files, and this is simpler to achieve if we don't need to support PDF +output, as it relieves us from the need to produce an abstract syntax +tree in the Pandoc representation. Producing PDF without a Pandoc AST +is trickier. + +Who: Daniel, Lars ## Minimum Supported Rust Version -Date: 2021-10-09 +Date: 2023-03-21 -What: We decided that Subplot would support an MSRV of 1.48.0 in -order that it can be maximally useful to the Sequoia-PGP project. -If and when we gain other large client projects, we will endeavour -to support an MSRV which makes them all happy. We will walk the -MSRV forward as and when our client projects move forward. +What: We decided that Subplot would support an MSRV of the version of +Rust in the Debian "testing" branch. We can bump our explicit MSRV +version when Debian gets a new version. Who: Daniel, Lars +## Threshold for refactoring + +Date: 2022-10-23 + +What: Instead of trying to do a whole code base tidy up, we'll +continuously do smaller refactoring changes when we see something that +needs improvement. + ## Do not clear/override all environment variables Date: 2021-10-08 |