;doc: reference manuals -> user manuals
This commit is contained in:
parent
201ea210fb
commit
28bcd9aadc
4
.github/ISSUE_TEMPLATE/a-bug.md
vendored
4
.github/ISSUE_TEMPLATE/a-bug.md
vendored
@ -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,
|
- 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
|
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,
|
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.
|
at the top of the page.
|
||||||
|
|
||||||
Things that can help us resolve your issue faster:
|
Things that can help us resolve your issue faster:
|
||||||
|
|||||||
4
.github/ISSUE_TEMPLATE/a-wish.md
vendored
4
.github/ISSUE_TEMPLATE/a-wish.md
vendored
@ -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;
|
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
|
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,
|
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.
|
at the top of the page.
|
||||||
|
|
||||||
Things that will move your request along faster:
|
Things that will move your request along faster:
|
||||||
|
|||||||
@ -606,7 +606,7 @@ though it's welcome (may be in a different repo).
|
|||||||
|
|
||||||
hledger follows documentation-driven design.
|
hledger follows documentation-driven design.
|
||||||
It is in fact highly effective, and highly recommended,
|
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,
|
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.
|
or in a "WIP" PR starting with just the proposed docs commit.
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user