Skip to content

Commit

Permalink
doc: rename & move files
Browse files Browse the repository at this point in the history
  • Loading branch information
Cryde committed May 26, 2024
1 parent 4b49a42 commit da339ed
Show file tree
Hide file tree
Showing 7 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion doc/index.MD → doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down
File renamed without changes

0 comments on commit da339ed

Please sign in to comment.