new xhc-whb04b-6 and hy_vfd documents

machinekit / machinekit-docs

Machinekit website

http://www.machinekit.io

16 stars 52 forks source link

new xhc-whb04b-6 and hy_vfd documents #295

Closed rubienr closed 5 years ago

rubienr commented 5 years ago

Hi folks,

I added some additional documents for the following components:

xhc-whb04b-6 (created new man page) and
hy_vfd (took the base from linuxcnc, finished the missing parts and fixed some errors).

See this pull request https://github.com/machinekit/machinekit/pull/1430 for more details.

br, raoul

ArcEye commented 5 years ago

I need to look at this properly in a bit.

man pages are generated, not written, so this is not displayed.
This would probably be better as a straight document.

ArcEye commented 5 years ago

There is no man or other page for the hy_vfd presently, so your page is welcome. Likewise the XHC-HB04 is currently dealt with by notes in the sources and sample configs.

If you change these 2 documents to docs/drivers/hy_vfd.asciidoc docs/drivers/xhc-whb04b-6.asciidoc and remove the man references, they will be visible there and a good addition

Also needs a reference to the xhc-whb04b-6 under the existing one to the xhc-hb04 in docs/gui/selector.asciidoc which will ensure it appears in the current search hits.

ArcEye commented 5 years ago

I have seen the xhc docs, they are previewed here http://preview.machinekit.io/docs/drivers/xhc-whb04b-6/ For some reason the hy_vfd one doesn't show, but I will sort that out once the main PR is merged.

ArcEye commented 5 years ago

I'll wait until the new full website is rendered after merge and see if the hy_vfd doc is visible. If not I will fix that directly. There may be a couple of other links needed, but I will do those in due course too.

Thanks for your contribution.

ArcEye commented 5 years ago

OK found the problem. There was a C style copyright notice left in above the top lines, which didn't prevent it rendering in github, but Jekyll did not recognise it as a proper asciidoc and failed to convert to html

It is now at http://www.machinekit.io/docs/drivers/hy_vfd/ and the xhc at http://www.machinekit.io/docs/drivers/xhc-whb04b-6/

Also added a couple of extra links so it can be found.

rubienr commented 5 years ago

Thank you for the support!

Now I see the tables are sticking out. I renderd with Asciidoctor.js in Chromium. Back then I thought a table might be a good idea. Now I doubt. Should that be refined?
I think, on the xhc-whb04b-6 page (section authors), I should remove the link to my github account. Name is enough.

ArcEye commented 5 years ago

The tables render just fine under Firefox, both under Linux and Windows. They make it very clear, so I would leave them.
Yes I would remove anything that could be scraped and used for hacking attempts or spam