From c7ba006c3f63d0fcf0bda5b367b3fa541a9fa571 Mon Sep 17 00:00:00 2001 From: Chris Adams Date: Mon, 1 Jul 2024 13:06:16 +0200 Subject: [PATCH] Update docs to include new guidance --- docs/index.md | 6 ++++-- docs/requirements.txt | 6 +++--- requirements/requirements.dev.in | 4 ++-- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/index.md b/docs/index.md index f2d78cbc..d783e3ee 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,12 +16,11 @@ This site also provides a summary of the other main libraries maintained by the [co2js]: https://github.com/thegreenwebfoundation/co2.js [grid-intensity-libraries]: https://github.com/thegreenwebfoundation?q=grid-intensity&type=all&language=&sort= -### Getting started +## Getting started Need to get going quickly? Start with [installation steps](installation.md), see [the answers to common questions](how-to.md), and if you need to push changes for review visit the [deployment instructions](deployment.md). ```{toctree} -general.md installation.md how-to.md deployment.md @@ -33,4 +32,7 @@ understanding-the flow-of-a-greencheck.md importers.md other-greenweb-software.md working-with-greenweb-datasets.md +working-with-docker.md +recurring-tasks.md +troubleshooting.md ``` diff --git a/docs/requirements.txt b/docs/requirements.txt index 89ebac5c..58680861 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -i https://pypi.org/simple -myst-parser==0.18.0 -furo==2022.6.21 -sphinxcontrib-mermaid==0.7.1 +myst-parser +furo +sphinxcontrib-mermaid diff --git a/requirements/requirements.dev.in b/requirements/requirements.dev.in index 262f933b..10740c10 100644 --- a/requirements/requirements.dev.in +++ b/requirements/requirements.dev.in @@ -21,8 +21,8 @@ sphinx-autobuild sphinxcontrib-mermaid # furo, myst-parser need to be pinned because # an underlying dependency, docutils needs a specific version of sphinx -furo==2022.4.7 -myst-parser==0.18.0 +furo +myst-parser ansible-lint django-browser-reload marimo