From 66e658f5937cf2bbb463359c3b11806f405b4862 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Thu, 13 Apr 2023 06:24:36 -1000 Subject: [PATCH] ;doc: ROADMAP: switch to markdown --- Shake.hs | 4 +-- doc/ROADMAP.md | 93 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/ROADMAP.org | 72 -------------------------------------- 3 files changed, 94 insertions(+), 75 deletions(-) create mode 100644 doc/ROADMAP.md delete mode 100644 doc/ROADMAP.org diff --git a/Shake.hs b/Shake.hs index 722fb6b63..0ad628443 100755 --- a/Shake.hs +++ b/Shake.hs @@ -763,12 +763,10 @@ main = do phony "orgfiles" $ need [ "doc/BACKLOG.md" - ,"doc/ROADMAP.md" ] -- These org files are converted to markdown for the website. - [ "doc/ROADMAP.md" - ,"doc/BACKLOG.md" + [ "doc/BACKLOG.md" ] |%> \out -> do let src = out -<.> "org" need [src] diff --git a/doc/ROADMAP.md b/doc/ROADMAP.md new file mode 100644 index 000000000..01862cbdd --- /dev/null +++ b/doc/ROADMAP.md @@ -0,0 +1,93 @@ +# ROADMAP + +
+ + +
+ + +Ideas about where the hledger project should be going next. +Being listed here suggests a bit of commitment, perhaps even a schedule. +Related: + +## Targets + +### Next Targets + +### Past Targets + +1. hledger 1.19, 2020-09-01 + + account transactions register, stricter/more correct handling of + unbalanced multicommodity transactions (#1177), Track & show + deposited lots (#1022), Report unrealized capital gains/losses + (#1029) + +2. hledger 1.18, 2020-06-01 + + more effective CI setup, updated home page, quickstart, tutorials + etc., negative matching in CSV rules, + +3. hledger 1.17, 2020-03-01 + + field matching in CSV rules, reduce install hassles with terminfo C + lib (?), more import/export options, simple console charts, + refreshed home page, faq, tutorials, manuals, + +4. hledger 1.16, 2019-12-01 + + ghc 8.8 support, more powerful CSV conversion, updated home page, + faq, manuals, reduce install hassles with terminfo C lib + +## 2020 Priorities + +### Documentation + +Improve the docs. + +- home & faq +- manuals (more discoverable structure of web manuals) +- cookbook docs (survey, plan, update) +- contrib guide (update, build from readmes) + +### Effectiveness + +Improve getting-started experience, just-works quality, practicality, +real-world usefulness. + +- ghc 8.8, get back in stackage nightly +- install issues (C libs..) +- more powerful CSV conversion +- fill out holes in feature matrix + +### Investment + +Improve suitability for investment tracking +([#1015](https://github.com/simonmichael/hledger/issues/1015)) + +- market price inference from transactions +- easy market price fetching +- lot tracking +- capital gains reporting + +### Charts + +Add charts and more visual appeal. + +- console charts, basic bar charts +- clarify architecture/UI for charts +- graphical charts using Chart/matplotlib/hvega +- review/design/add more attractive/colourful output (see eg + taskwarrior) + +### Correctness + +More support for enforcing correctness & accounting rules. + +- account names +- commodity symbols +- payees +- notes/descriptions ? +- account lifetimes ? +- account balance conditions ? +- transaction templates ? diff --git a/doc/ROADMAP.org b/doc/ROADMAP.org deleted file mode 100644 index b1f93b3ef..000000000 --- a/doc/ROADMAP.org +++ /dev/null @@ -1,72 +0,0 @@ -* ROADMAP.org -#+OPTIONS: -:nil - -Ideas about where the hledger project should be going next. Being -listed here suggests a bit of commitment, perhaps even a schedule. - -** Targets -*** Next Targets -*** Past Targets - -**** hledger 1.19, 2020-09-01 -account transactions register, stricter/more correct handling of -unbalanced multicommodity transactions (#1177), Track & show deposited -lots (#1022), Report unrealized capital gains/losses (#1029) -**** hledger 1.18, 2020-06-01 -more effective CI setup, updated home page, quickstart, tutorials -etc., negative matching in CSV rules, -**** hledger 1.17, 2020-03-01 -field matching in CSV rules, reduce install hassles with terminfo C -lib (?), more import/export options, simple console charts, refreshed -home page, faq, tutorials, manuals, -**** hledger 1.16, 2019-12-01 -ghc 8.8 support, more powerful CSV conversion, updated home page, faq, -manuals, reduce install hassles with terminfo C lib - -** 2020 Priorities -*** Documentation -Improve the docs. - -- home & faq -- manuals (more discoverable structure of web manuals) -- cookbook docs (survey, plan, update) -- contrib guide (update, build from readmes) - -*** Effectiveness -Improve getting-started experience, just-works quality, practicality, -real-world usefulness. - -- ghc 8.8, get back in stackage nightly -- install issues (C libs..) -- more powerful CSV conversion -- fill out holes in feature matrix - -*** Investment -Improve suitability for investment tracking -([[https://github.com/simonmichael/hledger/issues/1015][#1015]]) - -- market price inference from transactions -- easy market price fetching -- lot tracking -- capital gains reporting - -*** Charts -Add charts and more visual appeal. - -- console charts, basic bar charts -- clarify architecture/UI for charts -- graphical charts using Chart/matplotlib/hvega -- review/design/add more attractive/colourful output (see eg - taskwarrior) - -*** Correctness - -More support for enforcing correctness & accounting rules. - -- account names -- commodity symbols -- payees -- notes/descriptions ? -- account lifetimes ? -- account balance conditions ? -- transaction templates ?