Fork me on GitHub
#fulcro
<
2017-12-25
>
tpliliang00:12:58

@tony.kay Great:+1:, better if have a pdf version:grinning:

tony.kay02:12:25

easy to generate one, but not generally better: the live code demos won’t work there…Print -> As PDF. 😉

fatihict15:12:10

@tony.kay I am going to read the book right now. How would you like to discuss or receive feedback on parts that could be improved upon?

fatihict15:12:42

I really like the effort to combine the docs in one page by the way, not being able to search everything used to be a big bummer.

tony.kay16:12:49

@fatihict So, I very much appreciate it. I’m trying to think of the best way to help since there’s still a lot of major changes that need to happen. Besides simple typo checks, one big thing would be helping gap and dependency analysis. What order should things be in and where have I failed to talk about something important. As far as where to have discussion. I’ll start a PR of the book branch, and we can comment inline there I think. PM is ok, too.

tony.kay16:12:41

Oh, @fatihict, you should build it from source though. It is changing rapidly and I’m not pushing releases all that fast

fatihict16:12:06

Ok, will do

tony.kay16:12:24

for that matter, that way you could make a branch from book and issue a PR from yours to book.

tony.kay16:12:28

Instructions: 1. Start figwheel on the -Dbook build 2. In a terminal, I usually run

while true
do
  make book
  sleep 2
done
You’ll need a few tools. You have Linux or OSX or Win?

fatihict16:12:39

I'm on Linux

tony.kay16:12:18

you need ruby, then gems: asciidoctor, asciidoctor-diagram. You also need coderay but I don’t remember if that is a gem

tony.kay16:12:55

ah, it was a gem, too

tony.kay17:12:56

I think that’s it. I think the repo has all the sym links to make everything work from localhost:8080/book.html when running figwheel.

tony.kay17:12:59

you should have these:

$ ls -l resources/public/
total 240
lrwxr-xr-x  1 tonykay  staff     17 Dec 25 08:39 assets -> ../../docs/assets
lrwxr-xr-x  1 tonykay  staff     31 Dec 25 08:39 book.html -> ../../docs/DevelopersGuide.html
but git on Linux should create those without a problem.

fatihict17:12:22

Yeah, it did create those

fatihict17:12:29

Ok, got it running. Now I can also see the examples, I was wondering why they didn't load when I was viewing DevelopersGuide.adoc on Github

tony.kay17:12:00

Yeah, I’ve not changed the build to target the directory, so the js files are not checked in

tony.kay17:12:11

that’s why I made the separate website

tony.kay17:12:09

I didn’t want to churn big lists of files through the repo history by checking in js files

tony.kay17:12:03

@fatihict Oh, anchors and link for cross-reference would be nice if you care to do any more of those. I’ve started doing some. I think those are helpful.

fatihict17:12:21

^ for stuff like devcards?

fatihict17:12:37

And referencing different chapters?

tony.kay17:12:43

Yes, both. External links are nice. I was more talking about [[Blah]] on chapter or section headings and <<Blah, words>> to link to them when it makes sense

tony.kay17:12:17

Having the Getting Started chapter integrated means it makes a lot of sense to do quite a few of those from there, I think

fatihict17:12:49

Ah, great idea. Will do. I plan on reading the whole thing first, so I get a sense of the bigger picture and will note typos/weird sentences. Afterwards I can look into the ordering of chapters, what's missing and cross-referencing.

tony.kay17:12:44

OK, I won’t be around much today, but I’ll probably be working on it a lot more tomorrow.

tony.kay17:12:37

You’ll see a big string of ;;;;;;; where it goes back to old reference guide content

tony.kay17:12:50

then the demos are new at the bottom, merged in from the demos build

fatihict17:12:08

Alright, I'm also planning on working on it a lot more tomorrow. Merry christmas by the way 🎄

tony.kay17:12:28

yeah, thanks. Happy Newton’s Birthday to you, too 😉