Agoric / documentation

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

Created how-to-use-ui-kit explainer #1035

Closed kbennett2000 closed 6 months ago

kbennett2000 commented 6 months ago

Explainer for getting started with ui-kit

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

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2cc6961
Status: ✅  Deploy successful!
Preview URL: https://b9e16606.documentation-7tp.pages.dev
Branch Preview URL: https://kbennett2000-patch-5.documentation-7tp.pages.dev

View logs

LuqiPan commented 6 months ago

Just skipping through this PR, it seems to have overlap with various READMEs in ui-kit

How do we maintain this going forward? And who does the responsibility of updating docs fall on? Does this mean every time @samsiegart add a new ui-component to ui-kit repo, he'd need to also update the .md file in this repo too?

kbennett2000 commented 6 months ago

Just skipping through this PR, it seems to have overlap with various READMEs in ui-kit

How do we maintain this going forward? And who does the responsibility of updating docs fall on? Does this mean every time @samsiegart add a new ui-component to ui-kit repo, he'd need to also update the .md file in this repo too?

Good question @LuqiPan, would love to get @sufyaankhan's thoughts on who owns keeping docs up to date as we go. As it stands today, if an engineer creates a new component are they the one responsible for documenting it in the repo?

dckc commented 6 months ago

Just skipping through this PR, it seems to have overlap with various READMEs in ui-kit

oh. yes. it's pretty much a verbatim copy.

Our reference docs generation tools should take care of that, shouldn't they? But I suppose we're not there yet.

kbennett2000 commented 6 months ago

@sufyaankhan - Where should this go on the navigation?

kbennett2000 commented 6 months ago

Link to ui-tookit in Building Client Dapps (https://docs.agoric.com/guides/getting-started/contract-rpc.html) instead of stand-alone doc