diff options
| author | Christian Mollekopf <chrigi_1@fastmail.fm> | 2016-02-08 09:57:19 +0100 |
|---|---|---|
| committer | Christian Mollekopf <chrigi_1@fastmail.fm> | 2016-02-08 09:57:19 +0100 |
| commit | 1259fa9eb1595c141fb80a643b8618cc9e4f6db9 (patch) | |
| tree | 17f963d65f6c16c3c05a6c63a57d4440d30d95b4 /docs/index.md | |
| parent | 47bfba0d9152a1f7f689d7936b107b1a899a0b76 (diff) | |
| download | sink-1259fa9eb1595c141fb80a643b8618cc9e4f6db9.tar.gz sink-1259fa9eb1595c141fb80a643b8618cc9e4f6db9.zip | |
Documentation structure
Diffstat (limited to 'docs/index.md')
| -rw-r--r-- | docs/index.md | 27 |
1 files changed, 15 insertions, 12 deletions
diff --git a/docs/index.md b/docs/index.md index 3019cfd..36e309c 100644 --- a/docs/index.md +++ b/docs/index.md | |||
| @@ -1,15 +1,18 @@ | |||
| 1 | # Index | 1 | Sink is a data access layer handling synchronization, caching and indexing. |
| 2 | * Design | 2 | |
| 3 | * Design Goals | 3 | Discussion of the code should be done on the kde-pim at kde.org mailing list |
| 4 | * Overview | 4 | or in #kontact on IRC. |
| 5 | * Client API | 5 | |
| 6 | * Storage | 6 | Note that all feature development should happen in feature branches, and that |
| 7 | * Resource | 7 | the mainline development branch is "develop". Master is for releases. It is |
| 8 | * Facade | 8 | recommended (though not required) to use the "git flow" tools to make branched |
| 9 | * Logging | 9 | development easy (and easy for others to coordinate with): |
| 10 | * Extending Akoandi Next | 10 | |
| 11 | * Steps to add support for new types | 11 | https://github.com/nvie/gitflow |
| 12 | * Steps for adding support for a type to a resource | 12 | |
| 13 | For further information see: | ||
| 14 | |||
| 15 | https://phabricator.kde.org/project/view/5/ | ||
| 13 | 16 | ||
| 14 | # Documentation | 17 | # Documentation |
| 15 | This documentation is built using [mkdocs.org](http://mkdocs.org). | 18 | This documentation is built using [mkdocs.org](http://mkdocs.org). |