📝 — Improve documentation

argos/commands.py

@@ -43,8 +43,10 @@ def agent(server_url, auth, max_tasks, wait_time, log_level):
 
     Alternatively, you can use the following environment variables to avoid passing
     arguments to the agent on the command line:
-        ARGOS_AGENT_SERVER_URL=https://argos.server
+
-        ARGOS_AGENT_TOKEN=auth-token-here
+      \b
+      ARGOS_AGENT_SERVER_URL=https://argos.server
+      ARGOS_AGENT_TOKEN=auth-token-here
     """
     click.echo("Starting argos agent. Will retry forever.")
     from argos.logging import logger

docs/api.md

@@ -12,4 +12,4 @@ To access the API, you need to pass an authentication token in the `Authorizatio
 
 ## Endpoints
 
-You can also have access to the Swagger API documentation at http://<argos-url>/docs, and the ReDoc documentation at http://<argos-url>/redoc.
+You can also have access to the Swagger API documentation at `https://<argos-url>/docs`, and the ReDoc documentation at `https://<argos-url>/redoc`.

docs/developer/projects.md

@@ -0,0 +1,16 @@
+# Main projects and Python packages used by Argos
+
+## Python packages
+
+- [Click](https://click.palletsprojects.com/)
+- [FastAPI](https://fastapi.tiangolo.com/)
+- [HTTPX](https://www.python-httpx.org/)
+- [Jinja](https://jinja.palletsprojects.com/)
+- [Pydantic](https://pydantic.dev/)
+- [SQLAlchemy](https://www.sqlalchemy.org/)
+- [Tenacity](https://github.com/jd/tenacity)
+- [Uvicorn](https://www.uvicorn.org/)
+
+## CSS framework
+
+- [Pico.css](https://picocss.com/)

docs/index.md

@@ -64,6 +64,7 @@ checks
 developer/overview
 developer/new-check
 developer/models
+developer/projects
 changelog
 ```
 

docs/installation/getting-started.md

@@ -59,6 +59,6 @@ Here is a crontab example:
 
 ```bash
 # Run the cleaning tasks every hour (at minute 7)
-# Keeps the last 100000 results, and locks the tasks for 1 hour
+# Keeps 10 results per task, and locks the tasks for 1 hour
-7 * * * * argos server cleandb --max-results 100000 --max-lock-seconds 3600
+7 * * * * argos server cleandb --max-results 10 --max-lock-seconds 3600
 ```