diff --git a/docs/dev/dependencies.md b/docs/dev/dependencies.md new file mode 100644 index 00000000..ec3aa1d2 --- /dev/null +++ b/docs/dev/dependencies.md @@ -0,0 +1,22 @@ +# Packaging + +The packaging is handled by the `pyproject.toml` file for python dependencies, +and by `package.json` for JavaScript dependencies. + +## Python + +Python dependencies are pinned, and we're relying on Github's dependabot to +update them for us, via pull requests. + +## JavaScript + +Dependencies are **not** pinned, but a `^` character is used instead ([defined +by node semver](https://github.com/npm/node-semver#caret-ranges-123-025-004)), +meaning the next minor or patch versions will be installed (but not the next major) + +The installed libs needs to be: + +- Added to the `package.json` +- Added in the `scripts/vendorsjs.sh` script +- Loaded in the HTML templates. + diff --git a/docs/architecture/frontend.md b/docs/dev/frontend.md similarity index 100% rename from docs/architecture/frontend.md rename to docs/dev/frontend.md diff --git a/docs/architecture/overview.md b/docs/dev/overview.md similarity index 100% rename from docs/architecture/overview.md rename to docs/dev/overview.md diff --git a/mkdocs.yml b/mkdocs.yml index 999472b3..3590f0e0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,9 +7,10 @@ nav: - Getting started: install.md - Contribute: contributing.md - Release: release.md - - Architecture: - - Overview: architecture/overview.md - - Frontend: architecture/frontend.md + - Development: + - Overview: dev/overview.md + - Frontend: dev/frontend.md + - Dependencies: dev/dependencies.md - Configuration: - Settings: config/settings.md - Customize: config/customize.md