Documents proxy contracts in README

[acenolaza]

Initial documentation for the combinator proxy contracts

[Siegrift]

I get a sense you tried to document this for audit, but I'm not sure we have to chatty. The contracts here are rather simple and we need to explain we designed them to be composable and maybe show some examples. E.g. building wstETH/USD from Api3 feeds.

For the user docs, what I have in mind:

1. Document how to run the scripts to deploy the each of the combinators
2. Have some common use cases

[Siegrift]

Btw. I had to look deep into implementation of @api3/contracts to understand that I should populate MNEMONIC and ETHERSCAN_API_KEY_ETHEREUM for my deployment to work. The ugly thing it's not clear what "etherscan" is the Api3 using under the hood. I don't think this can easily be changed, so it needs to be carefully documented.

In other words, for the user. Assume a person who knows that this repo is used to combine Api3 proxies and wants to do it for their dApp. They have no idea about any Api3 internals.

It also needs to say that this is provided without a warranty and there is no coverage.

[acenolaza]

I get a sense you tried to document this for audit, but I'm not sure we have to chatty. The contracts here are rather simple and we need to explain we designed them to be composable and maybe show some examples. E.g. building wstETH/USD from Api3 feeds.

Yes, I tried giving as much context as needed for auditors to be able to understand the use-cases and design philosophy without much need of going to other repos/docs. I've now simplified a lot the README based on comments.

For the user docs, what I have in mind:

1. Document how to run the scripts to deploy the each of the combinators
2. Have some common use cases

Where do you think this user-facing docs should go? Same README file or a spearate file under /docs for instance?

[Siegrift]

Where do you think this user-facing docs should go? Same README file or a spearate file under /docs for instance?

This README and the audit/dev comments to a separate one. Similarly, how it's done in https://github.com/api3dao/api3-dao-dashboard?tab=readme-ov-file#development-instructions

[Siegrift]

We should also note somewhere that the user is NOT expected to commit/create-pr with the deployed files and they act only for their convenience.

[acenolaza]

We should also note somewhere that the user is NOT expected to commit/create-pr with the deployed files and they act only for their convenience.

Deployment artifacts are added to /deployments folder by hardhat-deploy but this folder was added to the .gitignore file 👍🏻