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

Update README.md #107

Merged
merged 3 commits into from
Apr 19, 2024
Merged

Update README.md #107

merged 3 commits into from
Apr 19, 2024

Conversation

samsiegart
Copy link
Contributor

Fix link to packages/react-components

Fix link to packages/react-components
@samsiegart samsiegart enabled auto-merge (squash) April 19, 2024 17:58
Copy link

cloudflare-workers-and-pages bot commented Apr 19, 2024

Deploying ui-kit with  Cloudflare Pages  Cloudflare Pages

Latest commit: 47b353c
Status: ✅  Deploy successful!
Preview URL: https://da6c7ddf.ui-kit-dwm.pages.dev
Branch Preview URL: https://samsiegart-patch-1.ui-kit-dwm.pages.dev

View logs

@samsiegart samsiegart requested a review from dckc April 19, 2024 18:00
@@ -10,7 +10,7 @@ Setup may vary by environment.

## React Apps

See [packages/react-components](https://github.com/Agoric/ui-kit) for convenient hooks and utilities that make setting up
See [packages/react-components](https://github.com/Agoric/ui-kit/tree/main/packages/react-components) for convenient hooks and utilities that make setting up
Copy link
Member

Choose a reason for hiding this comment

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

Unfortunately, this means when you're reading the generated docs, this link takes you out of them and back the github source view.

ideally, the link would go to https://samsiegart-patch-1.ui-kit-dwm.pages.dev/modules/_agoric_react_components when looking at the generated docs. But I don't see a straightforward way to do that.

One option would be

See the `@agoric/react-components` package for utilities such as {@link AgoricProvider} ...

but that link wouldn't work from within github.

@samsiegart samsiegart merged commit 53782cd into main Apr 19, 2024
2 checks passed
@samsiegart samsiegart deleted the samsiegart-patch-1 branch April 19, 2024 18:38
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.

2 participants