Fixing doc generation command examples.

day8 / re-frame

A ClojureScript framework for building user interfaces, leveraging React

http://day8.github.io/re-frame/

MIT License

5.44k stars 716 forks source link

Fixing doc generation command examples. #654

Closed phronmophobic closed 4 years ago

phronmophobic commented 4 years ago

I'm not sure what the slashes in the ns-to-markdown command are the wrong direction. Is that the windows command?

I also think the windows and linux commands were swapped for the docker commands.

The docs didn't specify which directory to run the docker commands from. I mistakenly thought it was supposed to be run from docs/ given the previous commands.

mike-thompson-day8 commented 4 years ago

I'm on windows and my experience is ....

phronmophobic commented 4 years ago

Ah, ok. I'm on a mac and the ${PWD} version is also the version that worked for me. I know what ${PWD} means, but I don't know what %cd% is supposed to do so I assumed it was some windows things (I'm very unfamiliar with windows).

mike-thompson-day8 commented 4 years ago

I have updated the README with your corrections: https://github.com/day8/re-frame/commit/1a257100a1778566fd600cf9733a091e1487ade5

Many Thanks!

mike-thompson-day8 commented 4 years ago

And one more: https://github.com/day8/re-frame/commit/e7137051742595c37f673f5be68531f40ac18a84