Author objectives for act 1

[rmkubik]

Objective List:

• [x] fs-01-path
  • [x] description
  • [x] walkthrough
  • [x] validator
• [x] fs-02-pwd
  • [x] description
  • [x] walkthrough
  • [x] validator
• [x] fs-03-ls
  • [x] description
  • [x] walkthrough
  • [x] validator
• [x] fs-04-cd
  • [x] description
  • [x] walkthrough
  • [x] validator
• [x] fs-05-mkdir
  • [x] description
  • [x] walkthrough
  • [x] validator

Please comment if you're tackling an objective!

[rmkubik]

I did a description for fs-01-path now. This description.md file has examples of how to use context and a new helper function to format content differently for Windows vs. Other.

[rmkubik]

Did description for fs-02-pwd!

Edit: Going to add those extra checkboxes to the main comment now instead of continually posting here. :-)

[rmkubik]

I'm worried about the description for fs-03-ls. I ended up using a CLI arg for ls to just show directories, ls -d */. The default ls doesn't distinguish what is and isn't a directory. I'm not stoked about needing to use a weird command so soon though. Perhaps we'd benefit from a "enter any file name or directory name at all that's in your ls result" objective before this one?

[rmkubik]

For fs-03-ls:

• Just give me the name of anything in your home directory, we validate it exists

For fs-04-cd:

• Give a single mock up tree
• Ask them to "mock cs into a dir" tell us the new the "pwd" - field 1
• Ask them to cd into a file, then tell us a new pwd - field 2

[rmkubik]

A note on description.md length.

Historically, we've tried to keep these as short as possible and move all instruction into the help tab instead.

Based on our experience with Press X to Learn, I'm sort of inclined to think that's not necessarily the best course of action like we thought it was originally. Keeping everything to ONE screen seems very common in the space.

These descriptions I'm writing have been soundly breaking that established pattern we used to commit to. I'm calling this out now because I'd like us to consider this moving forward... I don't really know what to do about it. :-)

[rmkubik]

Handy file tree editing web tool I've been using for this project: https://tree.nathanfriend.io/

[rmkubik]

The validator for fs-5 does not actually care that the player has made a new directory vs. found the path for an existing directory.

It seems like a player acting in good faith would not fall into this trap on accident. I'm not super bothered by a player trying to circumvent this intentionally since that would demonstrate their understanding of file systems beyond the scope of this course anyway I think.

We can go back and add more validation to prevent this if we want, but I think this is fine to ship for now at least.

[rmkubik]

These changes have been shipped in #10!