Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to include new guidance #607

Merged
merged 1 commit into from
Jul 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
6 changes: 3 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions requirements/requirements.dev.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down