On Sat, 8 Jun 2019 at 08:10, Phillip Carter <[email protected]> wrote:

How do I now view the documentation to ensure that it looks like it should.
>

You can view asciidoc directly on the Github page. However it only seems to
get rendered as asciidoc if it has the .asciidoc or .adoc extension.

See for example:
https://github.com/andypugh/linuxcnc/blob/master/docs/src/gui/gladevcp.adoc

You can edit the file directly on the github web site using the pencil icon
at the top right of the document frame. You can also change the file name
in that view.

So here is one possible workstream for docs changes:

. browse to the file, press the pencil icon
. change the name to .adoc and make the changes
. commit the changes and re-open the file
. if happy, edit again to change the name back.
. commit again, make pull request.

I don't see a way to squash the file renames in the web interface, though,
so you would need to rebase -i the commits at the command line before
submitting the pull request.
(This is something that the pull request acceptor can do if that is enabled
for the repo, but that feature is disabled for LinuxCNC)

-- 
atp
"A motorcycle is a bicycle with a pandemonium attachment and is designed
for the especial use of mechanical geniuses, daredevils and lunatics."
— George Fitch, Atlanta Constitution Newspaper, 1916

_______________________________________________
Emc-developers mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/emc-developers

Reply via email to