now made easy
# Description
Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.
## Checklist before requesting a review
Please delete options that are not relevant.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged
## Screenshots (if appropriate):
# Description
Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.
## Checklist before requesting a review
Please delete options that are not relevant.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged
## Screenshots (if appropriate):
# Description
Done some enhancement to the `README.md` file.
- Add blank space after `JWT_SECRET_KEY`
- **OS Compatible**: Ubuntu 22 or upper. -> **OS Compatible**: Ubuntu 22
or newer.
- Remove checkbox and add sublist instead.
```
- [ ] Change variables in `backend/.env` to - Change variables in `backend/.env`
- [ ] Change variables in `frontend/.env` to - Change variables in `frontend/.env`
```
* docs: Add prerequisites section in step 2
* feat: showing errors
* docs: specifying the prerequisites directly, stating that it is not necessary to perform further steps
---------
Co-authored-by: Zineb El Bachiri <100568984+gozineb@users.noreply.github.com>
By not specifying '-f docker-compose.yml' in the docker compose command, it allows
more flexible use of configuration files. docker-compose.yml is already the default
config file when none is specified, and this also allows overrides via
docker-compose.override.yml, which is recognized by default.
* 📝 add BACKEND_URL to documentation
* 📝 add migrations script to get_started doc
* 📝 add BACKEND_URL to documentation
* 📝 add Resend API to documentation
* 🔥 remove broken link in get_started doc
* Update intro.md
IMO, Migrations Script sounds like we have a Quivr v1, and there is a new architecture (v2), and we need to run these scripts to "migrate" to the new version.
* Update README.md
Revert change. It's included on intro.md
