Commit graph

195 commits

Author SHA1 Message Date
e386e86474 Add todo: Rewrite libimagerror with chain-error crate 2017-08-27 17:49:18 +02:00
2fcead5f53 Fix broken README symlinks
Along: Add files in documentation for modules that not yet had one.
2017-08-27 15:13:25 +02:00
Mario Krehl
8a63815854 Fix package name of libimagentryannotation
Fix: run `sed -i 's,libimagref,libimagentryref,g' (rg -l 'libimagref')`
Fix: run `sed -i 's,libimagannotation,libimagentryannotation,g' (rg -l 'libimagannotation')`
2017-08-27 15:13:25 +02:00
1c37703c32 Update version strings for next release: 0.3.0 -> 0.4.0 2017-08-26 13:27:32 +02:00
0f436d5b88 Merge pull request #1009 from matthiasbeyer/doc-overhaul
Doc overhaul
2017-08-25 18:34:11 +02:00
3001288442 Update date 2017-08-25 17:50:38 +02:00
abebf9c014 Fix format 2017-08-25 14:04:18 +02:00
49a7201125 Add documentation how the mail CLI should look like 2017-08-21 00:03:22 +01:00
d7b266a72c Add todos for maintenance scripts 2017-08-20 15:24:48 +01:00
469975d752 Add more ideas for modules 2017-08-20 14:46:34 +01:00
3e115b7014 Add todo for logger rewrite 2017-08-14 09:52:47 +00:00
5fa076914c Add docs on {habit,news,todo,wiki} lib 2017-08-12 21:26:55 +00:00
db51d971cc Improve mail module docs 2017-08-12 21:26:26 +00:00
740a5dad74 Cleanup intro 2017-08-12 21:26:02 +00:00
a96eb69b0f Basic documentation for read/write libs 2017-08-12 15:48:00 +00:00
d78288e6f7 Add files for libs 2017-08-12 15:37:17 +00:00
1c98dca547 Add basic descriptions for as many modules as possible 2017-08-11 22:20:11 +00:00
0e1925e5ae Add three more modules to do 2017-08-11 22:15:53 +00:00
6d73dae8a5 Add files for planned modules 2017-08-11 16:29:38 +00:00
31541fb1ba Fix filename 2017-08-11 12:59:40 +00:00
3d34ea0491 Add long-term todos in todo file 2017-08-11 09:13:42 +00:00
7ab0050a3d Remove outdated parts 2017-08-11 09:11:12 +00:00
7c227b4e4d Move contributing guidelines to documentation 2017-08-11 09:11:12 +00:00
f771337359 Remove 'Backend' sections, we dont need them 2017-08-11 09:03:46 +00:00
471e31172f Remove unused files 2017-08-10 19:47:19 +00:00
25db146dd5 Add architecture (and types) documentation 2017-08-10 19:44:19 +00:00
7a048f3795 Add file for coding conventions and best practices 2017-08-10 16:38:46 +00:00
b3e7f095ce Merge pull request #966 from matthiasbeyer/libimagtimetrack
imag-timetrack / libimagtimetrack
2017-06-29 14:55:39 +02:00
9583ae06cd Add README/documentation 2017-06-26 19:30:02 +02:00
dd7954ddb6 Add Documentation 2017-06-26 19:28:57 +02:00
0033d1b4b4 Add documentation file 2017-06-21 18:29:49 +02:00
266311d743 Change backends to do less ser-/deserialization
This commit changes the backends to do less de/ser, as it now stores the
Entry objects in the backend and does the de/serialization there.

This means the store does only serialize things once from json to toml
in the io backend.

See the diff of the documentation for more details.
2017-06-18 12:32:04 +02:00
c4b2287876 Move the documentation to the docs 2017-06-18 11:33:18 +02:00
9254851724 doc: Remove hook stuff 2017-06-06 11:12:37 +02:00
9650f46e23 Version strings: 0.2.0 -> 0.3.0 2017-05-03 10:48:26 +02:00
ccad830953 Add more long-term todos 2017-02-20 15:13:47 +01:00
d75bc2d928 Add TODOs about libimag{rt,store{,stdhook}} merge 2017-02-20 14:51:06 +01:00
eaf34ac6e9 Add long-term todos in libimagref 2017-02-20 14:51:06 +01:00
3a18655a7f Increment header levels in the README.md I missed in the first run 2016-10-13 12:07:54 +02:00
e30d774670 Move all libimag*/README.md to doc/src/05100-* 2016-10-13 12:04:36 +02:00
a2e2fc93b1 Add library documentation subchapter 2016-10-13 12:04:36 +02:00
da439e60e9 Add documentation what a valid tag is 2016-09-30 10:45:28 +02:00
69a10b2d02 Merge pull request #601 from matthiasbeyer/doc-updates
Doc updates
2016-08-02 13:01:40 +02:00
75f57d622c doc: Fix code listing 2016-07-30 21:36:45 +02:00
34e164e954 doc: Add more description of modules 2016-07-30 21:32:50 +02:00
40d4939f3a doc: Fix up store entry example markup and content 2016-07-30 21:02:21 +02:00
3e4d01a339 Add missing dependency: which 2016-07-30 20:59:49 +02:00
bbb5e58583 doc: Fix filename 2016-07-30 20:58:04 +02:00
6f71dc517f doc: Remove comment 2016-07-30 20:57:36 +02:00
9354ae003a doc: Fix bullet-list markup 2016-07-30 20:56:57 +02:00
4e230ecc61 doc: Update version 2016-07-30 20:55:18 +02:00
008f4d0032 Add new non-optional dependencies to doc in default.nix 2016-07-30 20:53:12 +02:00
0c5674dd47 Merge pull request #525 from matthiasbeyer/update-doc
Update doc
2016-07-14 21:11:30 +02:00
e250059390 doc: Add file for tagging module documentation 2016-07-13 18:34:58 +02:00
f36851786a doc: Add description for linking module 2016-07-13 18:34:00 +02:00
f8b1d48307 doc: Add user documentation for imag-diary 2016-07-13 18:27:36 +02:00
45d41748f6 doc: Add store module documentation 2016-07-12 17:12:16 +02:00
51432eaf39 Add example how to use imag-counter 2016-07-12 17:00:02 +02:00
9337a14cdd Update all version strings: 0.1.0 -> 0.2.0 2016-07-12 11:51:20 +02:00
1bf7d16664 doc: template: Add TOC 2016-07-08 21:11:28 +02:00
6f958d2a68 doc: template: title page plain 2016-07-08 21:11:28 +02:00
fd1fd6881a doc: template: Make the title page the title page only 2016-07-08 21:05:03 +02:00
ed4b198359 doc: Fix version string 2016-07-08 20:58:47 +02:00
9283d964d5 doc: Add most basic section structure for module files 2016-07-08 20:51:45 +02:00
a8206b8f19 doc: Remove comment markers 2016-07-08 20:48:41 +02:00
fafc8418df doc: Remove utility documentation, as the user should never see this 2016-07-08 20:43:32 +02:00
39c1b30e6f doc: Add module file for view 2016-07-08 20:43:32 +02:00
0b1356a104 doc: Rewrite initial text for module section 2016-07-08 20:43:25 +02:00
1c0fc5a0a7 doc: Remove file on tagging 2016-07-08 20:43:25 +02:00
5a229a24b0 doc: Add module files: {link, ref} 2016-07-08 20:43:25 +02:00
f81e47ceb2 doc: Rewrite linking chapter 2016-07-08 20:43:20 +02:00
7a8432123b doc: Rewrite "The Store" chapter 2016-07-08 20:43:12 +02:00
28a9c5ffc9 doc: Rewrote intro 2016-07-08 20:43:06 +02:00
12cb61cd8b doc: Rename documentation files for modules 2016-07-08 17:42:47 +02:00
d8c4d55312 doc: Add chapter on technical details 2016-07-08 17:39:19 +02:00
d0a5beae9a doc: Remove library documentation files 2016-07-08 17:37:58 +02:00
b0de23bfbf doc: Rename document, set new date 2016-07-08 17:37:47 +02:00
Gavin Thomas Claugus
2760e30d6c Define tasks for manpage generation
Signed-off-by: Gavin Thomas Claugus <gclaugus@gmail.com>
2016-07-03 13:27:11 -04:00
Gavin Thomas Claugus
9c6a9b5eed Define TARGET_MAN variable with manpage target dir
Signed-off-by: Gavin Thomas Claugus <gclaugus@gmail.com>
2016-07-03 13:13:48 -04:00
Gavin Thomas Claugus
7bc2c094a1 Export PANDOC_CC_MAN command
Signed-off-by: Gavin Thomas Claugus <gclaugus@gmail.com>
2016-07-03 13:12:51 -04:00
Gavin Thomas Claugus
c0042196da Add DOCUMENT_SETTINGS_MAN variable
Signed-off-by: Gavin Thomas Claugus <gclaugus@gmail.com>
2016-07-03 13:09:20 -04:00
Gavin Thomas Claugus
0185ab3fd8 Export manpage output directory
Signed-off-by: Gavin Thomas Claugus <gclaugus@gmail.com>
2016-07-03 13:06:18 -04:00
9fa362c22c Add initial proposal for notes module 2016-03-25 16:30:12 +01:00
f253931bb7 doc: Adjust documentation to match implementation 2016-03-16 16:46:54 +01:00
4dc1140149 doc: Add hook aspect definition 2016-03-16 16:46:52 +01:00
c9bca51273 doc: Add documentation for the Hook system 2016-03-16 16:46:51 +01:00
8d234440b5 doc: imag-counter 2016-03-15 15:01:10 +01:00
20201d2358 Merge pull request #210 from matthiasbeyer/doc/libimagutil
Doc/libimagutil
2016-03-07 17:18:50 +01:00
637faf2d66 Merge pull request #219 from matthiasbeyer/doc/add-module-files
Add module files for several modules
2016-03-07 17:14:30 +01:00
a02a0f2fde Merge pull request #167 from matthiasbeyer/doc/linking
doc: Add chapter on linking
2016-03-06 11:53:18 +01:00
fc46f1a8df doc: imag:// prefix should be optional 2016-03-06 11:18:31 +01:00
5b034dc37b doc: Add liblink specification 2016-03-06 11:18:01 +01:00
4b4809571a doc: Add paragraph in section for linking internal content 2016-03-06 11:17:30 +01:00
fc7a86ba50 doc: Add initial paragraph 2016-03-06 11:17:30 +01:00
a51b68e838 doc: Add chapter on linking 2016-03-06 11:17:26 +01:00
7ff1995acc Move files to new filenames, so we have alphabetical ordering 2016-03-02 17:32:24 +01:00
3c30cecee8 Add module files for several modules
Rename modules, so we have alphabetical order for the modules, which is
way nicer than the current order.

The following modules are added:

    - borrow
    - counter
    - cuecards
    - dairy
    - ledger
    - password
    - weather

Plus, this commit adds an utility module file, where the utility modules
are described
2016-02-29 20:21:51 +01:00
22b41004ae doc: Remove file for "libimagmodule", as this was removed 2016-02-21 20:33:36 +01:00
babb7b7055 doc: libimagutil: Add documentation of the generate_variants() util 2016-02-21 20:27:24 +01:00
6baa3c7f38 doc: libimagutil: Add error-tracing utility documentation 2016-02-21 20:27:23 +01:00