Added explainers for dapp-offer-up

Agoric / documentation

User documentation

https://agoric.com/documentation/

Apache License 2.0

15 stars 39 forks source link

Added explainers for dapp-offer-up #976

Closed kbennett2000 closed 5 months ago

kbennett2000 commented 7 months ago

Added explainers for:

How to Start a Local Chain -- https://github.com/Agoric/documentation/issues/934 -- https://github.com/Agoric/documentation/blob/kbennett2000-patch-1/main/guides/getting-started/explainer-how-to-start-a-local-chain.md
How to Deploy a Smart Contract -- https://github.com/Agoric/documentation/issues/935 -- https://github.com/Agoric/documentation/blob/kbennett2000-patch-1/main/guides/getting-started/explainer-deploying-a-smart-contact.md
How to Initiate an Offer -- https://github.com/Agoric/documentation/issues/936 -- https://github.com/Agoric/documentation/blob/kbennett2000-patch-1/main/guides/getting-started/explainer-how-to-make-an-offer.md

How Does Zoe Offer Work

NOTE: This uses the same explainer page as "How to Initiate an Offer" as both topics are covered -- https://github.com/Agoric/documentation/issues/937

cloudflare-workers-and-pages[bot] commented 7 months ago

Deploying documentation with Cloudflare Pages

Latest commit:	`a1a3e5c`
Status:	🚫 Build failed.

View logs

dckc commented 7 months ago

we've avoided spaces in filenames to date.

The norm for this repo seems to be kebab-case

dckc commented 7 months ago

Are these docs in the navigation structure? How does a reader get to them from the docs homepage?

kbennett2000 commented 7 months ago

Are these docs in the navigation structure? How does a reader get to them from the docs homepage?

https://miro.com/app/board/uXjVNpwnZ-I=/

dckc commented 7 months ago

The Making an Offer in dapp-offer-up video is good progress, but there are a lot of red squigglies that make it look like something is wrong.

dckc commented 7 months ago

Are these docs in the navigation structure? How does a reader get to them from the docs homepage?

https://miro.com/app/board/uXjVNpwnZ-I=/

This PR doesn't seem to reflect the structure in that miro board. Is editing the nav config files happening in some other PR?

https://github.com/Agoric/documentation/blob/main/main/.vuepress/config.js https://github.com/Agoric/documentation/blob/main/main/.vuepress/themeConfig/nav.js

kbennett2000 commented 7 months ago

Are these docs in the navigation structure? How does a reader get to them from the docs homepage?

https://miro.com/app/board/uXjVNpwnZ-I=/

This PR doesn't seem to reflect the structure in that miro board. Is editing the nav config files happening in some other PR?

https://github.com/Agoric/documentation/blob/main/main/.vuepress/config.js https://github.com/Agoric/documentation/blob/main/main/.vuepress/themeConfig/nav.js

As per @sufyaankhan's request, I'm building a prototype to show to new nav / doc structure before implementing any vuepress / vitepress changes.

https://github.com/kbennett2000/agoric-slides/

dckc commented 7 months ago

In the Starting a Local Chain video, the voice-over says

all the configuration for Docker is going to live right here in your package Json file

https://www.youtube.com/watch?v=WJ1MlHudpuM&t=42s

That doesn't seem quite right. Most of the configuration for docker is in docker-compose.yml.

dckc commented 7 months ago

@kbennett2000 is this intended to close 934 etc?

If so, it can help to make the link in such a way that project management tools grok.

dckc commented 6 months ago

Red squigly lines - .... If Dan could give a few mins to Kris (sometime) he can get that fixed.

We chatted briefly about using configure-vscode.sh

any luck, @kbennett2000 ?