;doc:DOCS: updates, add doc-update diagram

This commit is contained in:
Simon Michael 2025-09-26 14:06:07 -10:00
parent f000c3f116
commit 57abdd89d9

View File

@ -1,11 +1,14 @@
# Docs # DOCS
<div class=pagetoc> <div class=pagetoc>
<!-- toc --> <!-- toc -->
</div> </div>
## hledger's documentation structure An overview of hledger's documentation structure and process, for developers and maintainers.
(For user documentation, see [Docs](docs.md).)
## Documentation structure
<div style="margin:1em 2em; font-style:italic;"> <div style="margin:1em 2em; font-style:italic;">
"There is a secret that needs to be understood in order to write good "There is a secret that needs to be understood in order to write good
@ -227,6 +230,12 @@ In the release branch, once the corresponding github release is created, after u
1. Cherry pick the latest release notes (`doc/relnotes.md`) from the release branch to master. 1. Cherry pick the latest release notes (`doc/relnotes.md`) from the release branch to master.
2. Push to the master branch on github. The website's "Release notes" page will update automatically. 2. Push to the master branch on github. The website's "Release notes" page will update automatically.
### Diagrams
(approximate)
[![doc update diagrams](doc-update.png)](doc-update.png)
## 201901 docs reorg (#920, WIP) ## 201901 docs reorg (#920, WIP)