Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
wants to merge 3 commits into from
Closed

Conversation

kbennett2000
Copy link
Contributor

Explainer for getting started with ui-kit

Explainer for getting started with `ui-kit`
Copy link

cloudflare-workers-and-pages bot commented Mar 26, 2024

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

Copy link
Member

@dckc dckc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops... I've got some comments pending. I hope they're not outdated...

main/guides/getting-started/how-to-use-ui-kit.md Outdated Show resolved Hide resolved
}
```

### Using a Custom Signer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is using a custom signer required? If not, maybe demote it to after "Executing Offers"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unsure. Is this a question for @samsiegart?

@LuqiPan
Copy link
Contributor

LuqiPan commented Mar 27, 2024

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
Copy link
Contributor Author

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
Copy link
Member

dckc commented Mar 29, 2024

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.

Copy link
Member

@dckc dckc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this is a new page, this PR should add it to the navigation (nav.js and/or config.mjs)

@kbennett2000
Copy link
Contributor Author

@sufyaankhan - Where should this go on the navigation?

@kbennett2000
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants