ProtoSchool / protoschool.github.io

The code that runs the ProtoSchool website. Visit https://proto.school for interactive tutorials on decentralized web protocols. Explore IPFS and Filecoin through code challenges, code-free lessons, and local events.
https://proto.school
Other
166 stars 67 forks source link

Lesson Feedback: First Try: Can't Find Variable Error in Mutable File System - Lesson 4 (Add a file to MFS) #748

Open Annamarie2019 opened 2 years ago

Annamarie2019 commented 2 years ago

Have a question or suggestion regarding a specific ProtoSchool lesson? Please use this template to share it!

URL of the lesson that's confusing: https://proto.school/mutable-file-system/04

What's confusing about this lesson? At First I got the Can't Find Variable error. (See image below.)

The doc says, "So if we had a file object in our browser, accessible via a variable catPic, and we wanted to add it to our root directory on IPFS and have it be named cat.jpg, we could do it like so:

await ipfs.files.write('/cat.jpg', catPic, { create: true })"

So I tried to reproduce this with my file:

Screen Shot 2021-11-25 at 10 46 00 PM

I then realized that you wanted me to use the files API, as long as my file was in the browser:

Screen Shot 2021-11-27 at 7 54 46 AM

I think the text could explain this simply by saying that once the file is in the browser, Files accesses the file in the browser.

Aha! I skipped the Mutable File System section. The modules either have to be done in order, or preferably, a comment in the Add Regular Files API module to go see Mutable File System first (for wandering, wayward students, like myself, who skip ahead).

Clearly, a lot of great work went into this doc resulting in a lot of great info. Just needs some fresh energy to fine tune details of the organization (a second pair of eyes (I'm applying :blush: ) or the original writer coming back after a break).... Writing is an iterative process. Maybe this section should be called the Mutable Files API to balance with Regular Files API. (I was trying to skip ahead to the API doc. A parallel title would be a better guide.)

What additional context could we provide to help you succeed?

What other feedback would you like to share about ProtoSchool?