From da339ed6aba39cd5e5334ba0e47a3626b7aa4c1a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9my?= Date: Sun, 26 May 2024 11:45:53 +0200 Subject: [PATCH] doc: rename & move files --- README.md | 2 +- doc/{index.MD => README.md} | 2 +- ...ician-announce.MD => howto-musician-announce.md} | 8 ++++---- .../musician-announce/add-announce-modal.png | Bin .../musician-announce/announce-list.png | Bin .../musician-announce/last-announce-homepage.png | Bin .../musician-announce/profile-announce-access.png | Bin 7 files changed, 6 insertions(+), 6 deletions(-) rename doc/{index.MD => README.md} (84%) rename doc/{howto-musician-announce.MD => howto-musician-announce.md} (82%) rename doc/{ => images}/musician-announce/add-announce-modal.png (100%) rename doc/{ => images}/musician-announce/announce-list.png (100%) rename doc/{ => images}/musician-announce/last-announce-homepage.png (100%) rename doc/{ => images}/musician-announce/profile-announce-access.png (100%) diff --git a/README.md b/README.md index 4746f98a..205b56e3 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ npm run build You can now access http://musicall.localhost -[Learn how to use the application](doc/index.MD). +[Learn how to use the application](doc/README). ## TODO diff --git a/doc/index.MD b/doc/README.md similarity index 84% rename from doc/index.MD rename to doc/README.md index 69e9ac75..0e41a93b 100644 --- a/doc/index.MD +++ b/doc/README.md @@ -5,7 +5,7 @@ It will be split by "sections" related to the website. You should have MusicAll up and running as requirement (of course you can read this just for fun!) -- [How to use the musician announce](howto-musician-announce.MD) +- [How to use the musician announce](howto-musician-announce) _Note: this is an in progress doc, more to come_ \ No newline at end of file diff --git a/doc/howto-musician-announce.MD b/doc/howto-musician-announce.md similarity index 82% rename from doc/howto-musician-announce.MD rename to doc/howto-musician-announce.md index 640acd5e..b550fcb4 100644 --- a/doc/howto-musician-announce.MD +++ b/doc/howto-musician-announce.md @@ -10,17 +10,17 @@ _Note: right now it not possible to edit or remove announce_ To access the list you have to be logged in. Then you click on your profile menu (top right) and then click on "Mes annonces" : -![Access to the announces list](musician-announce/profile-announce-access.png) +![Access to the announces list](images/musician-announce/profile-announce-access.png) Once there you will see a list of your announces : -![The announces list](musician-announce/announce-list.png) +![The announces list](images/musician-announce/announce-list.png) From there you create a new one by clicking on "Ajouter une nouvelle annonce" This will open a modal that will guide you to create an announce. -![Add announce modal](musician-announce/add-announce-modal.png) +![Add announce modal](images/musician-announce/add-announce-modal.png) For this particular part here are the interesting endpoints : - `api_instruments_get_collection` to get the list of instruments @@ -32,7 +32,7 @@ For this particular part here are the interesting endpoints : Visitor can see last announce the other user have created. This part is available in the homepage : -![Last announce](musician-announce/last-announce-homepage.png) +![Last announce](images/musician-announce/last-announce-homepage.png) You will note that there is buttons to create an announce (we have seen that in the previous point) and search for an announce. diff --git a/doc/musician-announce/add-announce-modal.png b/doc/images/musician-announce/add-announce-modal.png similarity index 100% rename from doc/musician-announce/add-announce-modal.png rename to doc/images/musician-announce/add-announce-modal.png diff --git a/doc/musician-announce/announce-list.png b/doc/images/musician-announce/announce-list.png similarity index 100% rename from doc/musician-announce/announce-list.png rename to doc/images/musician-announce/announce-list.png diff --git a/doc/musician-announce/last-announce-homepage.png b/doc/images/musician-announce/last-announce-homepage.png similarity index 100% rename from doc/musician-announce/last-announce-homepage.png rename to doc/images/musician-announce/last-announce-homepage.png diff --git a/doc/musician-announce/profile-announce-access.png b/doc/images/musician-announce/profile-announce-access.png similarity index 100% rename from doc/musician-announce/profile-announce-access.png rename to doc/images/musician-announce/profile-announce-access.png