Commit Graph

754 Commits

Author SHA1 Message Date
Simon Michael
6aa1bbc18a ;doc: --debug help tweak 2024-06-26 23:24:41 +01:00
Simon Michael
d9f314dfa3 ;doc: update help 2024-06-25 18:37:55 +01:00
Simon Michael
40620666f8 imp: cli: rename --rules-file to --rules; tweak options help
For brevity, and consistency with --conf.
--rules-file remains supported, as a hidden option.

hledger's main mode now supports the hidden legacy flags,
as the command modes do.
2024-06-25 18:37:55 +01:00
Simon Michael
91d5308783 ;tools: Shake cmdhelp -> cmddocs, now runs hledger to update flag docs
Now, updating a command's docs (for hledger manual and for --help) requires
running the command (with stack exec -- hledger). The sequence is now
a bit recursive:

1. Run hledger CMD -h to update CMD.md with the latest cmdargs help output for CMD's flags.
   CMD.md is included in the hledger manual, when rendering that.
2. Convert CMD.md to CMD.txt, with pandoc.
3. Build hledger, embedding CMD.txt for cmdargs to use as -h output.

This need only be done after changing command docs or flags, and
hopefully won't be a hassle. Shake cmddocs now shows progress output
to make things clearer.
2024-06-07 14:35:31 -07:00
Simon Michael
30dbb9f393 ;doc: ghrelnotes: cleanups 2024-06-02 07:10:24 -10:00
Simon Michael
e85171c842 ;doc: ghrelnotes: fix mac, linux install commands 2024-06-02 07:02:02 -10:00
Simon Michael
245b082eb9 ;doc: relnotes.github: link to the build from source doc 2024-06-01 16:00:07 -10:00
Simon Michael
91591cd6cc ;doc: relnotes: 1.34: unwrap long lines 2024-06-01 15:50:51 -10:00
Simon Michael
18771d4dd6 ;doc: relnotes: fixes 2024-06-01 15:48:39 -10:00
Simon Michael
33d30bd188 ;doc: relnotes: update 2024-06-01 15:37:06 -10:00
Simon Michael
50c3f9720c ;doc: RELEASING: updates 2024-06-01 15:22:58 -10:00
Simon Michael
8f24fad909 ;doc: merge 1.34 release docs 2024-06-01 14:13:57 -10:00
Simon Michael
311be367b0 ;doc: cli: simplify, use generic help flags again 2024-05-31 19:54:18 -10:00
Simon Michael
7f583a8414 ;doc: correction, NO_COLOR does not override --color=yes 2024-05-31 18:16:33 -10:00
Simon Michael
4aa81da931 ;doc: sync with tldr docs 2024-05-29 17:30:50 -10:00
Simon Michael
d47513c669 ;doc: sync command summaries between manuals and tldr, updating both 2024-05-29 17:00:11 -10:00
Simon Michael
9d53698eab ;imp: cli: also mention 'y' and 'n' in help 2024-05-29 16:12:44 -10:00
Simon Michael
1295ea7678 ;doc: options cleanup 2024-05-29 15:32:19 -10:00
Simon Michael
4a57403684 doc: tldr: copy tldr pages to the hledger repo for robustness 2024-05-29 15:32:19 -10:00
Simon Michael
5f255e28ee ;doc: update/simplify general options list in the manuals 2024-05-29 10:00:34 -10:00
Simon Michael
68fb788c48 ;doc: tldr: translation instructions 2024-05-28 07:56:51 -10:00
Simon Michael
80fbd4b4f9 ;doc: tldr: mention tldr browser 2024-05-28 07:24:12 -10:00
Simon Michael
65aac621d4 ;doc: tldr: readme updates 2024-05-24 11:06:50 -10:00
Simon Michael
9deaa1c206 ;doc: tldr: readme updates 2024-05-24 11:05:30 -10:00
Simon Michael
2270e56828 ;doc: tldr: readme updates 2024-05-24 11:03:41 -10:00
Simon Michael
e2e21e7d61 ;doc: tldr: readme updates 2024-05-24 11:00:26 -10:00
Simon Michael
8a190e2012 ;doc: tldr: readme updates 2024-05-24 10:28:31 -10:00
Simon Michael
265183e835 ;doc: add (links to) old & new tldr pages 2024-05-23 16:22:58 -10:00
Simon Michael
46b79079bf ;doc: The flattening: adapt to the site's depth-1 page TOCs
and tweak command/screen headings.

This goes further in the direction of showing simple lists of topics
instead of outlines. mdbook-toc doesn't support configuring the TOC
depth this per page, so it has to be site wide.

Overall I feel this is better, see eg the hledger manual.  It hides a
lot of interesting topic names but a shorter, linear list is less
scary and clearer than a huge scrolling outline. Once you click in to
a section and find a subsection of interest, it's still easy to
bookmark/share those by clicking their heading.
2024-05-22 13:06:08 -10:00
Simon Michael
af568f1ae2 ;doc: ghrelnotes: simplify 2024-05-19 10:14:01 -10:00
Simon Michael
fe301e1672 ;doc: relnotes: cleanup 2024-05-19 09:55:49 -10:00
Simon Michael
5aed755b71 ;doc:,workflows: auto-generate github release notes 2024-05-19 09:55:02 -10:00
Simon Michael
076312b3d4 ;doc: relnotes.github: start mentioning github nicks
(enables Contributors avatar list)
2024-05-18 19:55:48 -10:00
Simon Michael
d0a0f337db ;doc: relnotes.github: fix curl urls 2024-05-18 19:49:05 -10:00
Simon Michael
b44ac4957f ;doc: relnotes.github: show relnotes, hide install instructions by default 2024-05-18 19:49:00 -10:00
Simon Michael
4fe0344d6d ;doc: ANNOUNCE*, relnotes.github: edits 2024-05-02 08:20:44 -10:00
Simon Michael
89de1ae764 ;doc: RELEASING: updates 2024-05-02 01:27:08 -10:00
Simon Michael
d52e248aab ;doc: relnotes: fixes 2024-05-02 01:23:43 -10:00
Simon Michael
54e4d00e68 ;doc: relnotes.github: fixes 2024-05-02 01:11:58 -10:00
Simon Michael
731fb7c97b ;doc: ANNOUNCE*: 1.33.1 2024-05-02 00:46:15 -10:00
Simon Michael
93b1070a6a ;doc: relnotes.github: 1.33.1 2024-05-02 00:46:15 -10:00
Simon Michael
fe5065de6f ;doc: relnotes: 1.33.1 2024-05-02 00:46:15 -10:00
Simon Michael
543e96b6bc ;doc: DEVFAQ, just: installdbg: simplify ghc-debug build command 2024-05-01 22:46:57 -10:00
Simon Michael
9ac905459f ;doc: relnotes.github: windows: add -Force to extract command, overwriting old hledger executables; cleanups 2024-05-01 22:46:53 -10:00
Simon Michael
e5c68dd7c0 ;doc: REGRESSIONS: edits 2024-05-01 19:16:52 -10:00
Simon Michael
4ae534e682 ;doc: REGRESSIONS: cleanup 2024-05-01 19:09:07 -10:00
Simon Michael
336162fd1c ;doc: DEVFAQ, REGRESSIONS: edits 2024-05-01 19:05:27 -10:00
Simon Michael
f07749e159 ;doc: DEVFAQ: updates 2024-05-01 17:39:33 -10:00
Simon Michael
e476124d6b ;doc: DEVFAQ: updates 2024-05-01 17:16:08 -10:00
Simon Michael
2eda0934f4 ;doc: DEVFAQ: edits 2024-05-01 16:36:25 -10:00