Skip to content

Commit

Permalink
⚡️ update documentation emojies
Browse files Browse the repository at this point in the history
* solving issue mdl29#130

deleted api-documentation.md and replaced the link to API documentation in main README.

* resolves mdl29#129 partly: changing Python emoji link

* resolves mdl29#129 : added yaml emoji to main README

* resolves mdl29#129 : updated HTML emoji link

* deleted logos directory as requested
  • Loading branch information
mpsb authored Apr 29, 2021
1 parent acd867d commit c657a4e
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 78 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ LPH.

- 📂 Backend documentation's directory is [here](doc/backend)
- [📝 Backend Documentation](server/README.md)
- [📝 API Documentation](doc/backend/API-documentation.md)
- [📝 API Documentation](server/README.md#how-to-play)
- [📸 model picture](doc/backend/model.png)


Expand All @@ -46,5 +46,5 @@ LPH.
## Tools

- :wrench: tools documentation directory is [here](doc/tools)
- ![python emoji](logos/python.png "python") python linter: [flake8](doc/tools/flake8.md)
- yaml linter : [yamllint](doc/tools/yamllint.md)
- ![python emoji](https://yannis-mlgrn.github.io/codmoji/src/emoji/python.png "python") python linter: [flake8](doc/tools/flake8.md)
- ![yaml emoji](https://yannis-mlgrn.github.io/codmoji/src/emoji/yaml.png "yaml") yaml linter : [yamllint](doc/tools/yamllint.md)
69 changes: 0 additions & 69 deletions doc/backend/API-documentation.md

This file was deleted.

12 changes: 6 additions & 6 deletions doc/frontend/frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@
- activity-navbar :
> display description room and if a user wrinting in the input
![html](../../logos/html.png) [html file](../../front/activity_bar.html)
![html emoji](https://yannis-mlgrn.github.io/codmoji/src/emoji/html.png) [html file](../../front/activity_bar.html)

- messages :
> Display a list of messages
![html](../../logos/html.png) [html file](../../front/messages-list.html)
![html emoji](https://yannis-mlgrn.github.io/codmoji/src/emoji/html.png) [html file](../../front/messages-list.html)

- room-list :
> display all joined room
![html](../../logos/html.png) [html file](../../front/room_list.html)
![html emoji](https://yannis-mlgrn.github.io/codmoji/src/emoji/html.png) [html file](../../front/room_list.html)



Expand All @@ -42,14 +42,14 @@
- room-editor :
> when the user click on it, he can create a room
![html](../../logos/html.png) [html file](../../front/room_editor.html)
![html emoji](https://yannis-mlgrn.github.io/codmoji/src/emoji/html.png) [html file](../../front/room_editor.html)

- message-editor :
> user can type the message in this input and send when he click on sending button
![html](../../logos/html.png) [html file](../../front/message_editor.html)
![html emoji](https://yannis-mlgrn.github.io/codmoji/src/emoji/html.png) [html file](../../front/message_editor.html)

- user-list :
> display users who wrote in the current room
![html](../../logos/html.png) [html file](../../front/user-list.html)
![html emoji](https://yannis-mlgrn.github.io/codmoji/src/emoji/html.png) [html file](../../front/user-list.html)
Binary file removed logos/html.png
Binary file not shown.
Binary file removed logos/js.png
Binary file not shown.
Binary file removed logos/python.png
Binary file not shown.
Binary file removed logos/vue-js.jpg
Binary file not shown.

0 comments on commit c657a4e

Please sign in to comment.