search

paritytech / xcm-docs

Documentation for XCM
12 stars 4 forks source link

Executor Config [draft] #7

Closed vstam1 closed 1 year ago

vstam1 commented 1 year ago

I don't know if we should document every type in xcm-builder, but certainly the most common ones, the ones we ourselves use and expect most people to use.

I feel like we should clearly explain what each of the config items represents and maybe link to clear config examples (can also be the xcm-examples). But I am not sure if we should go over many of the xcm-builder items. We could however do the main confusion ones that will probably be the mostly configurable items per parachain (Barrier, AssetTransactor, OriginConverter). Then again I feel like we could give some proper examples in the xcm-examples repo (or something like trappist).

franciscoaguirre commented 1 year ago

I don't know if we should document every type in xcm-builder, but certainly the most common ones, the ones we ourselves use and expect most people to use.

I feel like we should clearly explain what each of the config items represents and maybe link to clear config examples (can also be the xcm-examples). But I am not sure if we should go over many of the xcm-builder items. We could however do the main confusion ones that will probably be the mostly configurable items per parachain (Barrier, AssetTransactor, OriginConverter). Then again I feel like we could give some proper examples in the xcm-examples repo (or something like trappist).

I think we should explain the main ones for sure, the ones we expect most people to use. Then we can give more examples in the repo. I was also thinking (it was on the SUMMARY.md) that we should give the Cookbook chapter (the one in the reference section) a structure so anyone can go in there and search for something similar to their use case.