Update Resources section in docs (#809)

Author: droserasprout

CONTRIBUTING.md

@@ -1,84 +1 @@
-# DipDup contribution guide
-
-The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
-
-## For contributors
-
-### General
-
-- All code in this repository MUST be licensed under the [MIT License](./LICENSE.md).
-- Python code in this repository MUST run on Python 3.11. Using modern language features is encouraged.
-- Python code in this repository MUST run in Linux, macOS, Docker, and `amd64`/`arm64` environments. Windows SHOULD be supported as well.
-- We use the PDM package manager to set up the development environment. You SHOULD install it and run `pdm run -l` to see available shortcuts.
-- Have fun!
-
-### Git workflow
-
-- Branch names MUST follow `prefix/short-description` format. Prefixes currently in use: `feat` for features, `fix` for bugfixes, `docs` for documentation, `exp` for experiments, `ci` for GHA and Docker stuff, `aux` for everything else.
-- Commits in pull requests MUST be squashed when merging to `next`.
-- Issues and pull requests MUST have a descriptive title; they SHOULD be linked to each other, appropriately labeled, and assigned to maintainers while in progress.
-
-### Codestyle
-
-We use `isort` and `black` for autoformatting, `ruff` for linting, and `mypy` for typechecking. All checks MUST pass before merging the code to default branch. Everything not enforced by these tools is up to the developer. But here are some recommendations:
-
-- Consistency is the key. If you see a pattern in the codebase, follow it.
-- Use `NOTE`, `TODO`, and `FIXME` prefixes for meaningful comments. It greatly helps to navigate the codebase.
-- Lazy imports are important to keep startup time low for tiny commands. We also do it for project imports, so not a big deal.
-- Some methods and attributes made private to avoid polluting the public API. Feel free to access them from the outside if you know what you are doing.
-- Finally, about exact language features. F-string formatting is preferred over other syntax. Be careful with walrus operator. Don't forget else in conditional expressions. Listen to you mom. We have no consensus about the match-case yet.
-
-### Packaging
-
-- All dependencies MUST be declared in `pyproject.toml` file.
-- Non-development dependencies MUST be pinned to non-breaking versions (e.g. `^1.2.3`).
-- Core dependencies that we patch MUST be pinned to specific versions (e.g. `1.2.3`).
-
-### Changelog
-
-- All changes that affect user (developer) experience MUST be documented in the CHANGELOG.md file.
-- Changes that significantly affect DipDup maintainers' experience MAY be documented in the CHANGELOG.md file.
-- The changelog MUST conform to the "Keep a Changelog" specification (CI will break otherwise). Group order we use: Added, Fixed, Changed, Deprecated, Removed, Performance, Security, Other.
-- Lines describing changes MUST be sorted and begin with DipDup component name (`index: Added ...`). One of the following: ci, cli, codegen, coinbase, config, context, database, demos, deps, docs, exceptions, hasura, hooks, http, index, install, ipfs, jobs, metadata, models, projects, prometheus, sentry, tzkt.
-
-## Documentation
-
-- A page in Release Notes SHOULD accompany all major releases.
-
-## For maintainers
-
-### Security
-
-- GitHub alerts about dependencies that contain vulnerabilities MUST be investigated and resolved as soon as possible.
-- Security-related bugfixes MUST be mentioned in the changelog under the "Security" section.
-
-### Privacy
-
-- Crash reporting MUST be opt-in (disabled by default) both in config and project templates.
-- Sentry events and crash reports MUST NOT contain any sensitive information (IP addresses, hostnames, etc.)
-- DipDup SHOULD NOT perform network requests to APIs not defined in config as datasources. Current exceptions: GitHub.
-
-### Docker images
-
-- DipDup dockerfiles use autogenerated `requirements.txt` files. Maintainers MUST run `pdm run update` script on every change in dependencies.
-- Docker images for stable releases MUST be published on Docker Hub. They MAY also be published on GHCR.
-- Maintainers MAY publish arbitrary images on GHCR and remove them when not needed.
-
-### Installer
-
-- Installer module MUST depend on Python stdlib only.
-
-### Scaffolding
-
-- Project templates SHOULD cover all index types available in DipDup.
-- They also MAY contain additional features and integrations.
-
-### Demo projects
-
-- Demos are stored in `src` directory. They MUST be generated automatically from project templates using replay files.
-- Maintainers SHOULD run `pdm demos` command regularly to ensure that demo projects are up to date.
-
-### Releases
-
-- Release versions MUST conform to [Semantic Versioning](https://semver.org/). Releases that introduce breaking changes MUST be major ones.
-- Only the latest major version is supported in general. Critical fixes MAY be backported to the previous major release. To do so, create an `aux/X.Y.Z` branch from the latest stable tag, bump the DipDup version manually, and add a new tag.
+This page was moved to the [Contribution](https://dipdup.io/docs/contribution) page in docs.

README.md

@@ -24,36 +24,3 @@ DipDup is a Python framework for building smart contract indexers. It helps deve
 This project is maintained by the [Baking Bad](https://bakingbad.dev/) team.
 <br>
 Development is supported by [Tezos Foundation](https://tezos.foundation/) and [OnlyDust](https://www.onlydust.xyz).
-
-## Thanks
-
-### Sponsors
-
-Decentralized web requires decentralized funding. The following people and organizations help the project to be sustainable.
-
-- [@dansan566](https://github.com/dansan566)
-- [@royscheeren](https://github.com/royscheeren)
-
-Want your project to be listed here? We have nice perks for sponsors! Visit our [GitHub Sponsors page](https://github.com/sponsors/dipdup-io).
-
-### Contributors
-
-We are grateful to all the people who help us with the project.
-
-- [@852Kerfunkle](https://github.com/852Kerfunkle)
-- [@Anshit01](https://github.com/Anshit01)
-- [@arrijabba](https://github.com/arrijabba)
-- [@Fitblip](https://github.com/Fitblip)
-- [@gdsoumya](https://github.com/gdsoumya)
-- [@herohthd](https://github.com/herohthd)
-- [@Karantezsure](https://github.com/Karantezsure)
-- [@mystdeim](https://github.com/mystdeim)
-- [@nikos-kalomoiris](https://github.com/nikos-kalomoiris)
-- [@pravind](https://github.com/pravind)
-- [@sbihel](https://github.com/sbihel)
-- [@tezosmiami](https://github.com/tezosmiami)
-- [@tomsib2001](https://github.com/tomsib2001)
-- [@veqtor](https://github.com/veqtor)
-- [@xflpt](https://github.com/xflpt)
-
-If we forgot to mention you, or you want to update your record, please, open an issue or pull request.

docs/0.quickstart-evm.md

@@ -1,5 +1,5 @@
 ---
-title: "Quickstart on EVM"
+title: "Quickstart"
 description: "This page will guide you through the steps to get your first selective indexer up and running in a few minutes without getting too deep into the details."
 navigation.icon: "stars"
 network: "ethereum"

docs/0.quickstart-tezos.md

@@ -1,5 +1,5 @@
 ---
-title: "Quickstart on Tezos"
+title: "Quickstart"
 description: "This page will guide you through the steps to get your first selective indexer up and running in a few minutes without getting too deep into the details."
 navigation.icon: "stars"
 network: "tezos"

docs/13.contributing.md

@@ -6,11 +6,13 @@ nested: Resources
 
 # Troubleshooting
 
-This page contains tips for troubleshooting DipDup issues.
+This page contains tips for troubleshooting DipDup issues. Start with "General" section and then proceed to one that matches your problem.
 
-## Update DipDup to the latest version
+## General
 
-DipDup framework evolves rapidly just like blockchains do. We recommend keeping your project up-to-date with the latest version of DipDup. If you're getting a warning about the outdated version, run the following commands depending on your installation method:
+### Update DipDup to the latest version
+
+If you experience an issue, first of all, make sure that you're using the latest version of DipDup. If new release is available you'll see a warning message when running DipDup. You can update DipDup using the following commands depending on your installation method:
 
 ```shell [Terminal]
 # Built-in installer
@@ -27,37 +29,48 @@ poetry update
 
 # pip
 pip install --upgrade dipdup
-
 ```
 
 When using Docker images you can use `X` and `X.Y` tags to lock to specific major/minor releases:
 
-```docker
+```docker [Dockerfile]
 FROM dipdup/dipdup:{{ project.dipdup_version }}
 ```
 
-## Ensure that config is correct
+We follow semantic versioning, so you can safely update to a new patch version without any breaking changes.
+
+### Enable debug logging
+
+More logs can give you a clue about the reason for an issue. Enable them in config:
+
+```yaml [dipdup.yaml]
+logging: DEBUG
+```
+
+## Config
+
+### Ensure that config is correct
 
-DipDup config can be correct syntactically but not necessarily semantically. It's especially easy to make a mistake when actively using templates and environment variables. Use `config export` command to dump config the way DipDup "sees" it, after resolving all links and templates. `config env` command can help you to find missing environment variables.
+DipDup config can be correct syntactically but not necessarily semantically. It's especially easy to make a mistake when actively using templates and environment variables. Use `config export` command to dump config the way DipDup "sees" it, after resolving all links and templates.
 
-```shell
+```shell [Terminal]
 dipdup -c . -c configs/dipdup.sqlite.yaml config export
-dipdup -c . -c configs/dipdup.sqlite.yaml config env
 ```
 
-## Enable debug logging
+### Check env variables
 
-More logs can give you a clue about the reason for an issue. Enable them in config:
 
-```yaml [dipdup.yaml]
-logging: DEBUG
+`config env` command can help you to find missing environment variables.
+
+```shell [Terminal]
+dipdup -c . -c configs/dipdup.sqlite.yaml config env
 ```
 
-## Inspect crash reports
+<!-- Careful with compose. Throw inside. -->
 
-When an exception occurs DipDup saves crash dumps to  `~/local/share/dipdup/reports`. You can inspect them using `dipdup report` and `dipdup report show` commands.
+## Package
 
-## Use linters to find errors in your Python code
+### Use linters to find errors in your Python code
 
 Exceptions that occurred during callback execution are reraised as `CallbackError`s. If you experience this issue, most likely your code is incorrect. Luckily, the Python ecosystem has lots of tools called linters to help you find mistakes. Default DipDup project template includes black, ruff and mypy to check your code for errors and type mismatches. You can run them with the following commands:
 
@@ -74,22 +87,30 @@ mypy .
 
 See the `pyproject.toml` file in your project root for more details.
 
-## Visit blockchain explorers
+### Inspect the package structure
+
+## Blockchains
 
-### Tezos
+### Tezos: explorers
 
 [Better Call Dev](https://better-call.dev) is a blockchain explorer for Tezos smart contracts. It provides a more human-friendly interface than TzKT to explore exact contract calls and parameter/storage structures.
 
 ![BCD](assets/troubleshooting-bcd.png)
 
 Try it out when writing index definitions.
 
-## Got stuck? Ask for help
+## Found a bug?
+
+When an exception occurs DipDup saves crash dumps to `~/local/share/dipdup/reports`. You can inspect them using `dipdup report ls` and `dipdup report show` commands.
+
+If you think you've found a bug, please report it directly to the [GitHub Issues](https://github.com/dipdup-io/dipdup). For all other discussions.
+
+## Got stuck?
 
-We are always ready to answer your questions!
+Ask for help! We are always ready to answer your questions.
 
-If you think you've found a bug, please report it directly to the [GitHub Issues](https://github.com/dipdup-io/dipdup). For all other discussions, join our socials:
+ join our socials:
 
-* [Discord](https://discord.gg/aG8XKuwsQd) (preferred)
-* [Telegram](https://t.me/baking_bad_chat)
-* [Slack](https://tezos-dev.slack.com/archives/CV5NX7F2L)
+- [Discord](https://discord.gg/aG8XKuwsQd) (preferred)
+- [Telegram](https://t.me/baking_bad_chat)
+- [Slack](https://tezos-dev.slack.com/archives/CV5NX7F2L)

docs/14.troubleshooting.md renamed to docs/13.troubleshooting.md

@@ -0,0 +1,94 @@
+---
+title: Contribution
+description: "DipDup license and open source code."
+nested: Resources
+---
+
+# Contribution
+
+DipDup is a free and open-source software licensed under the [MIT License](#mit-license). The source code is available on [GitHub](https://github.com/dipdup-io/dipdup).
+
+## Contribution Guide
+
+The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
+
+### General
+
+- All code in this repository MUST be licensed under the [MIT License](#mit-license).
+- Python code in this repository MUST run on Python 3.11. Using modern language features is encouraged.
+- Python code in this repository MUST run in Linux, macOS, Docker, and environments on `amd64` and `arm64` architectures.
+- We use the PDM package manager to set up the development environment. You SHOULD install it and run `pdm run -l` to see available shortcuts.
+- Have fun!
+
+### Git workflow
+
+- Branch names MUST follow `prefix/short-description` format. Prefixes currently in use: `feat` for features, `fix` for bugfixes, `docs` for documentation, `exp` for experiments, `ci` for GHA and Docker stuff, `aux` for everything else.
+- Commits in pull requests MUST be squashed when merging to `next`.
+- Issues and pull requests MUST have a descriptive title; they SHOULD be linked to each other, appropriately labeled, and assigned to maintainers while in progress.
+
+### Codestyle
+
+We use several tools to enforce codestyle and code quality: `black` for autoformatting, `ruff` for linting, and `mypy` for typechecking. All checks MUST pass before merging the code to the default branch. Everything not enforced by these tools is up to the developer. But here are some recommendations:
+
+- Consistency is the key. If you see a pattern in the codebase, follow it.
+- Use `NOTE`, `TODO`, and `FIXME` prefixes for meaningful comments. They help a lot to navigate the codebase.
+- Lazy imports are important to keep startup time low for tiny commands. We also do it for project imports, so not a big deal.
+- Some methods and attributes made private to avoid polluting the public API. Feel free to access them from the outside if you know what you are doing.
+- Finally, about exact language features. f-string formatting is preferred over other syntax. Be careful with walrus operator. Don't forget else in conditional expressions. Listen to you mom. We have no consensus about the match-case yet.
+
+### Packaging
+
+- All dependencies MUST be declared in `pyproject.toml` file add pinned to non-breaking versions (e.g. `~1.2`).
+
+### Changelog
+
+- All changes that affect user (developer) experience MUST be documented in the CHANGELOG.md file.
+- Changes that significantly affect DipDup maintainers' experience MAY be documented in the CHANGELOG.md file.
+- The changelog MUST conform to the "Keep a Changelog" specification (CI will break otherwise). Group order we use: Added, Fixed, Changed, Deprecated, Removed, Performance, Security, Other.
+- Lines describing changes MUST be sorted and begin with DipDup component name (`index: Added ...`). One of the following: ci, cli, codegen, coinbase, config, context, database, demos, deps, docs, exceptions, hasura, hooks, http, index, install, ipfs, jobs, metadata, models, projects, prometheus, sentry, tzkt.
+
+### Documentation
+
+- A page in "Release notes" section MUST accompany all major releases. Minor releases SHOULD be documented as well.
+
+## Maintainer Guide
+
+### Security
+
+- GitHub Dependabot alerts about vulnerable dependencies MUST be investigated and resolved as soon as possible.
+- Security-related bugfixes MUST be mentioned in the changelog under the "Security" section.
+
+### Privacy
+
+- DipDup MUST NOT collect any data from users.
+- DipDup SHOULD NOT perform network requests to APIs not defined in config as datasources. Current exceptions: version check with GitHub.
+
+### Docker images
+
+- DipDup dockerfiles use autogenerated `requirements.txt` files. Maintainers MUST run `pdm run update` script on every change in dependencies.
+- Docker images for stable releases MUST be published on Docker Hub and GitHub Container Registry.
+- Maintainers MAY publish arbitrary images on GHCR and remove them when not needed.
+
+### Installer
+
+- Installer module MUST depend on Python stdlib only.
+
+### Scaffolding
+
+- Project templates SHOULD cover all index types available in DipDup.
+- They also MAY contain additional features and integrations.
+
+### Demo projects
+
+- Demos are stored in `src` directory. They MUST be generated automatically from project templates using replay files.
+- Maintainers SHOULD run `pdm demos` command regularly to ensure that demo projects are up to date.
+
+### Releases
+
+- Release versions MUST conform to [Semantic Versioning](https://semver.org/). Releases that introduce breaking changes MUST be major ones.
+- Only the latest major version is supported in general. Critical fixes MAY be backported to the previous major release. To do so, create an `aux/X.Y.Z` branch from the latest stable tag, bump the DipDup version manually, and add a new tag.
+
+## MIT License
+
+<!-- markdownlint-disable first-line-h1 -->
+{{ #include ../LICENSE }}