From 28bcd9aadc48d18ef8dfad2e4e8312fdc4f94e97 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 25 Dec 2020 15:34:53 -0800 Subject: [PATCH] ;doc: reference manuals -> user manuals --- .github/ISSUE_TEMPLATE/a-bug.md | 4 ++-- .github/ISSUE_TEMPLATE/a-wish.md | 4 ++-- CONTRIBUTING.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/a-bug.md b/.github/ISSUE_TEMPLATE/a-bug.md index cccb17ffc..8406cc408 100644 --- a/.github/ISSUE_TEMPLATE/a-bug.md +++ b/.github/ISSUE_TEMPLATE/a-bug.md @@ -12,9 +12,9 @@ Some things to check before reporting: - If you're not sure this is a bug, or if some discussion would help, contact us on chat or the mail list first: https://hledger.org#help-feedback -- Have you looked at (the right version of) the reference manual ? +- Have you looked at (the right version of) the user manual ? Use `hledger help [--help]` to view the built-in manuals, - or view the hledger.org -> REFERENCE MANUALS and choose the right version + or view the hledger.org -> USER MANUALS and choose the right version at the top of the page. Things that can help us resolve your issue faster: diff --git a/.github/ISSUE_TEMPLATE/a-wish.md b/.github/ISSUE_TEMPLATE/a-wish.md index b64a7392e..cabe43fd4 100644 --- a/.github/ISSUE_TEMPLATE/a-wish.md +++ b/.github/ISSUE_TEMPLATE/a-wish.md @@ -13,9 +13,9 @@ Some things to check before requesting: Often it's best to discuss and attract interest on chat or the mail list first; use your best judgement. https://hledger.org#help-feedback -- Have you looked for related features in (the right version of) the reference manual ? +- Have you looked for related features in (the right version of) the user manual ? Use `hledger help [--help]` to view the built-in manuals, - or view the hledger.org -> REFERENCE MANUALS and choose the proper version + or view the hledger.org -> USER MANUALS and choose the proper version at the top of the page. Things that will move your request along faster: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 36e9f46ff..1469172e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -606,7 +606,7 @@ though it's welcome (may be in a different repo). hledger follows documentation-driven design. It is in fact highly effective, and highly recommended, -to write the new docs (help text/reference manual/haddocks/developer README..) before writing any code. +to write the new docs (help text/user manual/haddocks/developer README..) before writing any code. You can share a rough draft on IRC, on the mail list, in an issue comment, or in a "WIP" PR starting with just the proposed docs commit.