search

Agoric / documentation

User documentation
https://agoric.com/documentation/
Apache License 2.0
15 stars 40 forks source link

3 overlapping / redundant zoe offer safety pages #918

Open dckc opened 7 months ago

dckc commented 7 months ago

We have 3 attempts to define what actually ZOE is:

seems like we should be able to consolidate them.

dckc commented 5 months ago

keep privateArgs docs

let's make sure we keep one of these:

$ grep -ri privateArgs guides/zoe/
guides/zoe/contract-upgrade.md:The result of starting a contract includes the right to upgrade the contract. A call to [E(zoe).install(...)](/reference/zoe-api/zoe.md#e-zoe-startinstance-installation-issuerkeywordrecord-terms-privateargs) returns a record of several objects that represent different levels of access.
guides/zoe/contract-requirements.md:The second argument, `privateArgs`, is used by the caller of `startInstance`
guides/zoe/contract-requirements.md:`privateArgs` is an object with keys and values as decided by the caller of
guides/zoe/contract-requirements.md:`startInstance`. If no private arguments are passed, `privateArgs` is undefined.
guides/zoe/contract-requirements.md:const start = (zcf, privateArgs) => {
guides/zoe/offer-enforcement.md:(see [`startInstance`](/reference/zoe-api/zoe.md#e-zoe-startinstance-installation-issuerkeywordrecord-terms-privateargs)).
guides/zoe/README.md:_See also [E(zoe).startInstance(...)](/reference/zoe-api/zoe.md#e-zoe-startinstance-installation-issuerkeywordrecord-terms-privateargs)._
sufyaankhan commented 3 months ago

There was nothing substantial in the other 2 deprecated zoe pages that I read that needed to be in the 3rd published page. What is out there looks good enough to me.