mirror of
https://github.com/openfoodfacts/smooth-app.git
synced 2025-08-06 18:25:11 +08:00
450b461f1e
Bumps [file_picker](https://github.com/miguelpruivo/flutter_file_picker) from 10.2.0 to 10.2.1. - [Release notes](https://github.com/miguelpruivo/flutter_file_picker/releases) - [Changelog](https://github.com/miguelpruivo/flutter_file_picker/blob/master/CHANGELOG.md) - [Commits](https://github.com/miguelpruivo/flutter_file_picker/commits) --- updated-dependencies: - dependency-name: file_picker dependency-version: 10.2.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Submodule containing all the logic of the Smoothie app.
In the future, it will receive as parameters:
- a barcode decoding algorithm
- how to manage the review on the app store
Documentation
We use mkdocs for our documentation. mkdocs is a static site generator that's geared towards project documentation. It is written in Python.
How to use mkdocs
-
Install
mkdocs:pip install mkdocs mkdocs-material -
Serve the documentation locally:
mkdocs serveThis will start a local server at
http://127.0.0.1:8000/where you can view the documentation. -
Build the documentation:
mkdocs buildThis will generate a static site in the
sitedirectory.
Deploying the documentation
We use GitHub Pages to host our documentation. The deployment is handled automatically by a GitHub Actions workflow.
To manually deploy the documentation, you can use the following command:
mkdocs gh-deploy
This will build the documentation and push it to the gh-pages branch of the repository.