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

Various docs in various working states are confusing #117

Open
tennox opened this issue Oct 28, 2022 · 1 comment
Open

Various docs in various working states are confusing #117

tennox opened this issue Oct 28, 2022 · 1 comment

Comments

@tennox
Copy link

tennox commented Oct 28, 2022

(I'm describing my journey of trying to develop a Vue app during the UCAN build apps with IPFS workshop in the Hackerbase)

There's the fancy docs, which are:

  • missing the docs for the Provider
  • use an uploader variable which is not defined
  • use UploaderProviderInjectionKey.encodeFile which is called uploadFile in the latest library version

There's the github docs which

  • have the provider
  • have a bare-bones UI
  • are very different to the code I copied from the fancy docs

There's the codesandbox (linked in the fancy docs) which

  • work
  • are a bit more similar to the fancy docs, but also different variable names again and
  • much more UI stuff

Would be great to have a single source of truth 😅

Also, all docs are based on Vue 2 format, which is a bit sad for me 😋 (but not bad per se)

@jchris
Copy link
Contributor

jchris commented Nov 4, 2022

Thank you so much for writing this up. We really appreciate it!

I wonder how feasible it would be to drive all these from the same build source.

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

No branches or pull requests

2 participants