From 88ade4c07657837f0fd9425a8683c81a7eca8409 Mon Sep 17 00:00:00 2001 From: librelois <c@elo.tf> Date: Sun, 2 May 2021 16:15:58 +0200 Subject: [PATCH] [doc] dev: add index --- CONTRIBUTING.md | 9 +++++++-- doc/dev/index.md | 12 ++++++++++++ 2 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 doc/dev/index.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 18af7ae71..044fe2d50 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,6 +11,10 @@ via [the technical forum] before making a change. Please note we have a specific workflow, please follow it in all your interactions with the project. +## Developer documentation + +Please read [Developer documentation] before contribute. + ## Workflow - You must create an issue for each feature you wish to develop, with a precise title and a @@ -46,7 +50,8 @@ Please note we have a specific workflow, please follow it in all your interactio - @Moul - @c-geek +[commit naming conventions]: ./doc/dev/git-conventions.md#naming-commits +[Developer documentation]: ./doc/dev/index.md +[project's git conventions]: ./doc/dev/git-conventions.md [Setting up your development environment]: ./doc/dev/setup_env_dev.md [the technical forum]: https://forum.duniter.org -[project's git conventions]: ./doc/dev/git-conventions.md -[commit naming conventions]: ./doc/dev/git-conventions.md#naming-commits diff --git a/doc/dev/index.md b/doc/dev/index.md new file mode 100644 index 000000000..b30ff27bd --- /dev/null +++ b/doc/dev/index.md @@ -0,0 +1,12 @@ +Title: Developer documentation for Duniter +Order: 9 +Date: 2021-05-02 +Slug: doc-dev +Authors: elois + +# User documentation for Duniter Server + +- [Setting up your development environment](./setup_env_dev.md) +- [Git conventions](./git-conventions.md) +- [Project architecture](./architecture.md) +- [How to test a change in the schema of a DB](./test-db-change.md) -- GitLab