6.0 docs refresh (#436)

Author: droserasprout

Dockerfile

@@ -27,7 +27,6 @@ RUN <<eot
     echo 'dipdup ALL = NOPASSWD: /usr/bin/inject_pyproject.sh' >> /etc/sudoers
     chmod +x /usr/bin/inject_pyproject.sh
     chmod +x /usr/bin/inject_pyproject
-    apt uninstall -y make git
     rm -r /root/.cache
 eot
 

docs/CONTRIBUTING.md

@@ -0,0 +1 @@
+{{ #include ../CONTRIBUTING.md }}

docs/Makefile

@@ -24,7 +24,6 @@ docs:
 	tail -n '+34' _build/html/cli-reference.html | head -n '-63' > cli-reference.md
 	tail -n '+34' _build/html/config-reference.html | head -n '-63' > config/reference.md
 	tail -n '+34' _build/html/context-reference.html | head -n '-63' > advanced/context/reference.md
-	poetry run python ../scripts/print_help.py > troubleshooting/common-issues.md
 	mdbook build  --dest-dir=dist/docs
 
 homepage:

docs/SUMMARY.md

@@ -1,61 +1,55 @@
 # Table of contents
 
-[Overview](README.md)
+[Introduction](README.md)
 
 # User Guide
 
 * [Quickstart](quickstart.md)
 * [Getting started](getting-started/README.md)
   * [Installation](getting-started/installation.md)
   * [Core concepts](getting-started/core-concepts.md)
-  * [Preparing inventory](getting-started/preparing-inventory.md)
+  * [Creating config](getting-started/creating-config.md)
   * [Project structure](getting-started/project-structure.md)
-  * [Templates and variables](getting-started/templates-and-variables.md)
   * [Defining models](getting-started/defining-models.md)
   * [Implementing handlers](getting-started/implementing-handlers.md)
+  * [Templates and variables](getting-started/templates-and-variables.md)
 * [Advanced usage](advanced/README.md)
   * [Datasources](advanced/datasources.md)
-  * [Hooks](advanced/hooks/README.md)
-    * [Default hooks](advanced/hooks/default.md)
-    * [Job scheduler](advanced/hooks/jobs.md)
+  * [Hooks](advanced/hooks.md)
+  * [Event hooks](advanced/event-hooks.md)
+  * [Job scheduler](advanced/jobs.md)
   * [Reindexing](advanced/reindexing.md)
   * [Feature flags](advanced/feature-flags.md)
-  * [Executing SQL scripts](advanced/sql.md)
+  * [SQL scripts](advanced/sql.md)
   * [Improving performance](advanced/performance.md)
   * [Callback context (ctx)](advanced/context/README.md)
-    * [Full reference](advanced/context/reference.md)
   * [Internal models](advanced/internal-models.md)
-  * [Spawning indexes at runtime](advanced/index-factories.md)
-  * [Scheduler configuration](advanced/scheduler.md)
+  * [Index factories](advanced/index-factories.md)
   * [Metadata interface](advanced/metadata-interface.md)
 * [GraphQL API](graphql/README.md)
   * [Hasura integration](graphql/hasura.md)
   * [REST endpoints](graphql/rest.md)
   * [GenQL](graphql/genql.md)
-* [Troubleshooting](troubleshooting/README.md)
-  * [Common issues](troubleshooting/common-issues.md)
-  * [Reporting bugs](troubleshooting/reporting-bugs.md)
 * [Deployment and operations](deployment/README.md)
   * [Database engines](deployment/database-engines.md)
-  * [Building Docker images](deployment/docker.md)
-  * [Deploying with docker-compose](deployment/docker-compose.md)
-  * [Deploying with Docker Swarm](deployment/swarm.md)
+  * [Running in Docker](deployment/docker.md)
   * [Sentry integration](deployment/sentry.md)
   * [Prometheus integration](deployment/prometheus.md)
   * [Logging](deployment/logging.md)
-  * [Monitoring](deployment/monitoring.md)
   * [Backup and restore](deployment/backups.md)
-* [Cookbook](cookbook/README.md)
-  * [Processing offchain data](cookbook/offchain-data.md)
-  * [Reusing typename for different contracts](cookbook/reusing-typenames.md)
-  * [Synchronizing multiple handlers/hooks](cookbook/sync-callbacks.md)
-  * [Multiprocessing](cookbook/multiprocessing.md)
-* [Examples](examples/README.md)
-  * [Demo projects](examples/demo-projects.md)
-  * [Built with DipDup](examples/built-with-dipdup.md)
-* [Services (plugins)](services/README.md)
-  * [mempool](services/mempool.md)
-  * [metadata](services/metadata.md)
+* [F.A.Q.](faq.md)
+* [Troubleshooting](troubleshooting.md)
+* [Contribution guide](CONTRIBUTING.md)
+
+# Examples
+
+* [Demo projects](examples/demo-projects.md)
+* [Built with DipDup](examples/built-with-dipdup.md)
+
+# Standalone Services
+
+* [mempool](services/mempool.md)
+* [metadata](services/metadata.md)
 
 # Reference Guide
 
@@ -64,6 +58,7 @@
   * [Full reference](config/reference.md)
   * [advanced](config/advanced.md)
   * [contracts](config/contracts.md)
+  * [custom](config/custom.md)
   * [database](config/database.md)
   * [datasources](config/datasources.md)
   * [hasura](config/hasura.md)
@@ -73,7 +68,9 @@
     * [head](config/indexes/head.md)
     * [operation](config/indexes/operation.md)
     * [template](config/indexes/template.md)
+    * [token_transfer](config/indexes/token_transfer.md)
   * [jobs](config/jobs.md)
+  * [logging](config/logging.md)
   * [package](config/package.md)
   * [prometheus](config/prometheus.md)
   * [sentry](config/sentry.md)

docs/advanced/context/README.md

@@ -1,43 +1,7 @@
 # Callback context (`ctx`)
 
-> 🚧 **UNDER CONSTRUCTION**
->
-> This page or paragraph is yet to be written. Come back later.
-
 An instance of the `HandlerContext` class is passed to every handler providing a set of helper methods and read-only properties.
 
-## `.reindex() -> None`
-
-Drops the entire database and starts the indexing process from scratch. `on_index_rollback` hook calls this helper by default.
-
-## `.add_contract(name, address, typename) -> Coroutine`
-
-Add a new contract to the inventory.
-
-## `.add_index(name, template, values) -> Coroutine`
-
-Add a new index to the current configuration.
-
-## `.fire_hook(name, wait=True, **kwargs) -> None`
-
-Trigger hook execution. Unset `wait` to execute hook outside of the current database transaction.
-
-## `.execute_sql(name) -> None`
-
-The `execute_sql` argument could be either name of SQL script in `sql` directory or an absolute/relative path. If the path is a directory, all `.sql` scripts within it will be executed in alphabetical order.
-
-## `.update_contract_metadata(network, address, token_id, metadata) -> None`
-
-Inserts or updates the corresponding row in the service `dipdup_contract_metadata` table used for exposing the [5.11 Metadata interface](../metadata-interface.md)
-
-## `.update_token_metadata(network, address, token_id, metadata) -> None`
-
-Inserts or updates the corresponding row in the service `dipdup_token_metadata` table used for exposing the [5.11 Metadata interface](../metadata-interface.md)
-
-## `.logger`
-
-Use this instance for logging.
-
-## `.template_values`
+## Reference
 
-You can access values used for initializing a template index.
+{{ #include reference.md}}