shadow-cljs / shadow-cljs.github.io

shadow-cljs homepage
http://shadow-cljs.org
28 stars 74 forks source link

Out of date html on website??? #55

Open cloojure opened 4 years ago

cloojure commented 4 years ago

Hi - I was going to submit a PR to clarify some language, but I can't find it in the source on GH. Then, I notice this on the webpage https://shadow-cljs.github.io/docs/UsersGuide.html:

Shadow CLJS User’s Guide
Thomas Heller and Tony Kay
Version 1.0,
Jan 10, 2018

It is possible a very old version of the docs are being served on the webpage?

Alan

thheller commented 4 years ago

The sources are here: https://github.com/shadow-cljs/shadow-cljs.github.io/tree/master/docs

I just never update those versions or date. I'll probably just remove those.

cloojure commented 4 years ago

Hi - What I'm trying to say is that I think Github Pages is serving a very old version of the docs. For example, I was trying to fix some grammer on section "3.1 Command Line" and I could not find it in the source file.

Just compare the source version (left) and the GH pages version (right). They are very different, even just looking at the index.

Alan

On Mon, Aug 10, 2020 at 8:24 AM Thomas Heller notifications@github.com wrote:

The sources are here: https://github.com/shadow-cljs/shadow-cljs.github.io/tree/master/docs

I just never update those versions or date. I'll probably just remove those.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/shadow-cljs/shadow-cljs.github.io/issues/55#issuecomment-671421768, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABWBOB4MPBYWDN4NLGYEXBTSAAGKVANCNFSM4P2AUJIQ .

thheller commented 4 years ago

https://github.com/shadow-cljs/shadow-cljs.github.io/blob/master/docs/usage.adoc ?

cloojure commented 4 years ago

OK, it looks like the numbering is all screwy, and that is what threw me off. Notice there are 2 section "1" entries. The "Usage" is found under section 1.2, "Library", but labelled section "3" when published online. Screenshots attached. Alan

On Mon, Aug 10, 2020 at 8:41 AM Thomas Heller notifications@github.com wrote:

https://github.com/shadow-cljs/shadow-cljs.github.io/blob/master/docs/usage.adoc ?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/shadow-cljs/shadow-cljs.github.io/issues/55#issuecomment-671431271, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABWBOB4B667WVU77XO2OE4LSAAIKBANCNFSM4P2AUJIQ .

thheller commented 4 years ago

There are no attachments? Guess they get lost when you send this over email?

The headings are generated via the main file which just includes all the others (eg. include::usage.adoc[]). So the headings in the individual files are adjusted to match the main ones.

https://raw.githubusercontent.com/shadow-cljs/shadow-cljs.github.io/master/docs/UsersGuide.adoc

cloojure commented 4 years ago

Screen Shot 2020-08-10 at 8 35 50 AM Screen Shot 2020-08-10 at 8 57 08 AM

cloojure commented 4 years ago

Screen Shot 2020-08-10 at 8 57 21 AM

cloojure commented 4 years ago

OK, I guess you can only include attachments directly from the GH site.

So, I guess the content is correct the but screwy labels make it hard to find the correct file to edit! I'm surprised you have any numbers at all, much less repeating numbers like "1 About this book" and then "1 Instllation".

thheller commented 4 years ago

I have never looked at the github previews for these files but I guess the live-preview in IntelliJ also has the same issues. I never go by the numbers so I haven't noticed. Don't think there is anything to do about this. I want the final result to be one file but it got really annoying editing one huge file so I split them out into multiple. There may be better ways to do this but this is working fine for me.