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.

Sign up for GitHub

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

Jump to bottom

Update w3ui website examples #138

Closed
alanshaw opened this issue Dec 5, 2022 · 6 comments · Fixed by storacha/w3ui-website#12
Closed

Update w3ui website examples #138

alanshaw opened this issue Dec 5, 2022 · 6 comments · Fixed by storacha/w3ui-website#12
Assignees
@yusefnapora
Milestone
w3up phase 1

Comments

@alanshaw
Copy link
Member

alanshaw commented Dec 5, 2022 •
edited by yusefnapora
Loading

The code snippets on the website need updating. They are simplified, and mostly just have styles removed, but also have some code simplifications to make it as easy as possible to understand.

refs #117
@alanshaw alanshaw added this to the w3up phase 1 milestone Dec 5, 2022
@heyjay44 heyjay44 mentioned this issue Dec 5, 2022
Closed
51 tasks
@jchris
Copy link
Contributor

jchris commented Dec 5, 2022

does it make sense to bring those examples into this repo, and then put them into the test suite? eg the website would just pull the files from this repo during build. and the tiny example would be part of the test suite here. (If we decide to do this, we should track it in a new issue)

@yusefnapora yusefnapora mentioned this issue Dec 5, 2022
Merged
12 tasks
@heyjay44
Copy link

heyjay44 commented Dec 6, 2022

@jchris does it make sense to push the piece of work you suggested to the website initiative?
If it could save some time and effort, I think it would be worthwhile.
cc @dchoi27

@dchoi27
Copy link
Contributor

dchoi27 commented Dec 6, 2022

which work are you referring to? looks like @yusefnapora already started on it

@heyjay44
Copy link

heyjay44 commented Dec 6, 2022

@dchoi27 setup a test suite for the examples to eventually go into. It may not make sense right now but given the pace at which things change, it might be helpful?

@dchoi27
Copy link
Contributor

dchoi27 commented Dec 6, 2022

ah i see!

@jchris
Copy link
Contributor

jchris commented Dec 6, 2022

I think creating the core test suite would be a core engineering thing. Once it is in place, maintaining it can be support

yusefnapora added a commit to storacha/w3ui-website that referenced this issue Dec 13, 2022
@yusefnapora
feat: update example code & load examples from files (#12)
e4417ba 
closes storacha/w3ui#138

The big change (apart from the example content) is that I added
`raw-loader` so we can import the code samples from files instead of
embedding the source into the page. Apparently in webpack 5 you're
supposed to use [asset
modules](https://webpack.js.org/guides/asset-modules/) instead, but I
wasn't able to make it give me the original source - it wants to
transpile everything with SWC first. I fought with it for an hour before
giving up and using `raw-loader`, which still works fine despite its
deprecated status.

updated / reviewed examples:

- [x] keyring
  - [x] react
  - [x] solid
  - [x] vue
- [x] uploader
  - [x] react
  - [x] solid
  - [x] vue
- [x] uploads-list
  - [x] react (no changes)
  - [x] solid
  - [x] vue (no changes)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yusefnapora yusefnapora

Labels
None yet
Projects
None yet
Milestone
w3up phase 1
Development

Successfully merging a pull request may close this issue.

feat: update example code & load examples from files storacha/w3ui-website
5 participants
@jchris @alanshaw @yusefnapora @heyjay44 @dchoi27