update documentation

This commit is contained in:
Sam
2019-07-14 20:44:10 +02:00
parent ac53018dac
commit c0e4cc64bd
33 changed files with 718 additions and 26 deletions

View File

@ -36,7 +36,7 @@ In this release 1 issue was closed.
In this release 7 issues were closed.
## Version 0.1 - Minimal version (2018-07-04)
## Version 0.1.0 - Minimal version (2018-07-04)
### Issues Closed

View File

@ -40,6 +40,7 @@ Table of contents
installation
features
api/index
troubleshooting/index
changelog

View File

@ -0,0 +1,13 @@
Troubleshooting
###############
Administrator
~~~~~~~~~~~~~
`JSON.parse: unexpected character at line 1 column 1 of the JSON data`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
On the **Network Tab**, if the requests are made to `http://localhost:3000/undefined/api`, that means the environnement variable **REACT_APP_API_URL** is not initialized.
Check if **Makefile.custom.config** file exists and **REACT_APP_API_URL** is correctly initialized (see [example](https://github.com/SamR1/FitTrackee/blob/master/Makefile.custom.config.example)), and rebuild the client.

View File

@ -0,0 +1,10 @@
Administrator
#############
`JSON.parse: unexpected character at line 1 column 1 of the JSON data`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
On the **Network Tab**, if the requests are made to `http://localhost:3000/undefined/api`, that means the environnement variable **REACT_APP_API_URL** is not initialized.
Check if **Makefile.custom.config** file exists and **REACT_APP_API_URL** is correctly initialized (see `example <https://github.com/SamR1/FitTrackee/blob/master/Makefile.custom.config.example>`__), and rebuild the client.

View File

@ -0,0 +1,9 @@
Troubleshooting
#################
.. toctree::
:maxdepth: 2
:caption: Endpoints:
administrator
user

View File

@ -0,0 +1,5 @@
User
####
``TODO``