From 2393f982517707d025f029c24c60b1637ad0be38 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Mon, 27 Sep 2021 01:56:13 -1000 Subject: [PATCH] ;doc: add page TOCs to more dev docs --- BENCHMARKS.md | 4 ++++ CODE.md | 4 ++++ DOCS.md | 4 ++++ FUNDING.md | 4 ++++ PULLREQUESTS.md | 4 ++++ TESTS.md | 4 ++++ 6 files changed, 24 insertions(+) diff --git a/BENCHMARKS.md b/BENCHMARKS.md index 65b681793..02f152e9c 100644 --- a/BENCHMARKS.md +++ b/BENCHMARKS.md @@ -1,5 +1,9 @@ # Benchmarks +
+ +
+ Benchmarks are standard performance measurements, which we define using `bench` declarations in cabal files. There is [one in hledger.cabal](https://github.com/simonmichael/hledger/blob/master/hledger/hledger.cabal#L228), diff --git a/CODE.md b/CODE.md index 0875ef186..eeb219c68 100644 --- a/CODE.md +++ b/CODE.md @@ -1,5 +1,9 @@ # Code +
+ +
+ hledger is a suite of applications, tools and libraries. The main hledger code repository is [github.com/simonmichael/hledger](https://github.com/simonmichael/hledger) (shortcut url `code.hledger.org`). diff --git a/DOCS.md b/DOCS.md index ebba9086b..2b3e4a482 100644 --- a/DOCS.md +++ b/DOCS.md @@ -1,5 +1,9 @@ # Docs +
+ +
+ 20191209: needs update. See also doc/README. ## Four kinds of documentation diff --git a/FUNDING.md b/FUNDING.md index 7c626449b..8b4d7074e 100644 --- a/FUNDING.md +++ b/FUNDING.md @@ -1,5 +1,9 @@ # Funding +
+ +
+ My vision for the hledger project has always been for it to be "accountable" and "self-sustaining", possibly through new forms of incentivisation. Classic non-monetary FOSS communities are a beautiful and precious thing. Adding money can change their dynamic. diff --git a/PULLREQUESTS.md b/PULLREQUESTS.md index 908ea2146..f8d9672d1 100644 --- a/PULLREQUESTS.md +++ b/PULLREQUESTS.md @@ -1,5 +1,9 @@ # Pull requests +
+ +
+ Most contributed hledger code (and some of the project maintainer's code) is submitted and reviewed via Github pull requests. Here are some tips for contributing PRs to hledger. diff --git a/TESTS.md b/TESTS.md index a6f495d55..60346d647 100644 --- a/TESTS.md +++ b/TESTS.md @@ -1,5 +1,9 @@ # Tests +
+ +
+ About testing in the hledger project, as of 201809. ## Kinds of tests