diff options
Diffstat (limited to 'docs/index.md')
| -rw-r--r-- | docs/index.md | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/docs/index.md b/docs/index.md index 3019cfd..90d04b6 100644 --- a/docs/index.md +++ b/docs/index.md | |||
| @@ -1,17 +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](https://github.com/nvie/gitflow) 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 | For further information on the project see the [KDE Phabricator instance](https://phabricator.kde.org/project/view/5/). |
| 12 | * Steps for adding support for a type to a resource | ||
| 13 | 12 | ||
| 14 | # Documentation | 13 | # Documentation |
| 15 | This documentation is built using [mkdocs.org](http://mkdocs.org). | 14 | This documentation is built using [mkdocs.org](http://mkdocs.org). |
| 16 | 15 | ||
| 17 | Use `mkdocs serve` to run a local webserver to view the docs. | 16 | Use `mkdocs serve` to run a local webserver to view the docs. |
| 17 | |||
| 18 | The documentation is also published at [http://api.kde.org/doc/sink/](http://api.kde.org/doc/sink/) and rebuilt nightly. | ||