Links to documentation are outdated about consensusj HOT 4 CLOSED

Fixed: 730fa9a

Note there are three links in this file with three different use cases. For each use case there are three different scenarios:

1. Rendered to static HTML by asciidoctor (applies to local file: URLs in build/site and when published to Github pages.)
2. Previewed in Chrome (or Firefox) with asciidoctor extension.
3. Viewed directly in the Github repository and rendered by Github's server-side Asciidoctor.

The three files are:

• README
  This one should always link to the latest README on Github, so it is an absolute reference.
• JavaDoc
  This content is generated, so we're using an absolute reference to the Github pages site, so it will work when viewed in the repository on Github. (I suppose it might be possible use a conditional and to have it use a relative link to the generated JavaDoc in the other cases, but this isn't strictly necessary and I don't know how to do it yet.)
• User's Guide
  This uses a relative link (with a conditional outfilesuffix setting) that will switch between .adoc and .html as appropriate.

from consensusj.

@dexX7 Wanted to make sure you saw the above comments and commit diff as it may teach you a useful AsciiDoctor trick or two.

from consensusj.

@msgilligan: actually I'm not sure, if I understand.

I installed the asciidoctor-chrome-extension and this is currently the behavior I see:

• When browsing on index.adoc, then GitHub renders the document as usual, and there is a link to the user's guide as .adoc file. Clicking on that link redirects to the GitHub rendered version.
• When browsing on index.adoc (raw), then it looks like it's rendered by my browser, and there is still the link to the user's guide as .adoc file. However, clicking on that link also redirects to the raw version.

Edit: ahh, I see! When using the raw version, then the link to the README redirects back to GitHub, while the user's guide remains to be rendered by the browser!

from consensusj.

I typically use the Chrome Extension to preview AsciiDoctor files that I'm editing locally in a text editor. (Although the IntelliJ plugin-in is pretty nice, too.)

from consensusj.