slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc:DOCS

Browse Source
This commit is contained in:
Simon Michael 2025-09-26 09:41:34 -10:00
parent a98f007ed1
commit 908468b976
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/DOCS.md
View File

@ -77,19 +77,19 @@ Last updated: 2025-09
### Update manuals' content ### Update manuals' content
Updates to the manuals' content are welcome and encouraged! Updates to the manuals' content are welcome and encouraged!
They can be committed together with related code changes, or separately.
Note the various formats and versions of the manuals are generated from source files. Note the manuals have (a) source files and (b) files generated from these by scripts.
Don't edit the generated files, such as `hledger/hledger.md` in the hledger repo or `site/src/1.50/hledger.md` in the hledger_site repo; Don't edit the generated files, such as:
update the appropriate source file(s) instead. These will be in the master branch of the hledger repo. - `hledger/hledger.md` or `hledger-ui/hledger-ui.md` in the hledger repo
If you click "Edit this page" on a current release manual on the website, you'll see a comment listing its source files.) - `site/src/1.50/hledger*.md` in the hledger_site repo
In the main hledger repo, find and update Instead, edit the source file(s), in the hledger repo's master branch. Usually that means:
It is usually `hledger/hledger.m4.md` or `hledger/Hledger/Cli/Commands/*.md` for the hledger manual, - `hledger/hledger.m4.md` or `hledger/Hledger/Cli/Commands/*.md` for the hledger manual
or `hledger-ui/hledger-ui.m4.md` for the hledger-ui manual, - `hledger-ui/hledger-ui.m4.md` for the hledger-ui manual
or `hledger-web/hledger-web.m4.md` for the hledger-web manual. - `hledger-web/hledger-web.m4.md` for the hledger-web manual.
If you click "edit this page" on a recent release manual on the website, you'll see all of its source files listed.
Changes to manuals' content can be committed with the related code changes, or separately.
### Compile the Shake script ### Compile the Shake script