How do I github an update to https://linuxcnc.org/docs/html/gcode/g-code.html ?

More
18 Sep 2023 22:15 #281109 by Vector
There's a teensy weensy fix that's needed in the g-code.html page:

At the bottom of that Section 2: Quick Reference Table: it's missing G97 -- it should be nestled right next to G96: same link to the tag and everything because the section on G96 documents G97 as well.

It may be that someone needs to push a propagate/generate button somewhere...

...because: when I went to github to try and make a pull request to fix that (**ridiculous, heroic bicep flexes**) the only doc I could find was:

github.com/LinuxCNC/linuxcnc/blob/master...rc/gcode/g-code.adoc

And the fix is already there.

I'm guessing some process publishes the .html from the .adoc, and perhaps it needs to be initiated?

Obviously, an almost zero priority. But I'm also wondering how it works.

Thanks!
 

Please Log in or Create an account to join the conversation.

More
18 Sep 2023 23:34 #281118 by andypugh
I think that the key here is that you are looking at the current (2.8) docs but looking at the development (ie 2.10) page source.

github.com/LinuxCNC/linuxcnc/blob/2.8/docs/src/gcode/g-code.txt

Doesn't have G97.

You might also notice that the file changed from .txt to .adoc too.
The following user(s) said Thank You: Vector

Please Log in or Create an account to join the conversation.

More
19 Sep 2023 00:15 #281120 by Vector
Related question:

This doc: linuxcnc.org/docs/html/gcode/overview.html

Can also use some changes.

Similar, but different question: the corresponding (I think) github document is here: github.com/LinuxCNC/linuxcnc/blob/master.../gcode/overview.adoc

But that asciidoc doesn't have the section numbering system that shows up at the public-facing .html file, and when I do an asciidoc conversion of it, I don't get numbering either. (I do get that some deprecated markup is being used, fyi)

But the numbering is very helpful.

I think I'm going to have the same question about linuxcnc.org/docs/devel/html/gui/qtdragon.html vs github.com/LinuxCNC/linuxcnc/blob/master...rc/gui/qtdragon.adoc

So I'm wondering if I'm on the wrong channel/path for proposing changes.

Can someone set me straight?

Thanks!

Please Log in or Create an account to join the conversation.

More
19 Sep 2023 00:58 #281125 by Vector
@andypugh, thanks for responding.

So, I think you are saying if I wanted to I could fork 2.8 and suggest the change, and if approved, it would get pushed to the public facing
linuxcnc.org/docs/html/gcode/g-code.html which is 2.8. (This might not be worth anyone's effort, other than for my learning benefit)

Any guess on how long before 2.9 becomes current?

And what about the numbering question? When Rod and I worked on the Getting LinuxCNC , I guess I didn't notice that my local preview of the .adc file (using a asciidoctor plugin) didn't have numbering of the main section, but when it published with our changes, it does.
And when I  do an asciidoctor conversion, it doesn't convert the .adoc to .html with section numbering.
How do I get that preview?

 

Please Log in or Create an account to join the conversation.

More
19 Sep 2023 13:17 #281163 by andypugh

So, I think you are saying if I wanted to I could fork 2.8 and suggest the change


Well, you _could_, but in this case it's very esy for me to do it live on github:
github.com/LinuxCNC/linuxcnc/blob/2.8/docs/src/gcode/g-code.txt

Any guess on how long before 2.9 becomes current?


Not really. It comes down to when the must-fix bugs get fixed, and when I get the time.
The following user(s) said Thank You: Vector

Please Log in or Create an account to join the conversation.

More
19 Oct 2023 03:17 - 19 Oct 2023 06:13 #283268 by Vector
OK, I've been away for awhile but I'm able to work on this a bit.

I've made what I believe are clarifying changes to the NGC documentation.

My credentials for this are mainly that I just went through learning NGC from this documentation and tweaking the qtDragon M6 remapping, so I can remember vividly the places where this documentation left me scratching.

I may have jumped the gun on this post... my pull request didn't compile: there was a formatting code that my system allows but the compile checks do not.

The checks are in progress, but I already posted this thread with the (now closed) old pull request, so I'll update it with the new one in case someone looks at this in the meantime.

Is this the right place to advocate for the changes here at my pull request?
github.com/LinuxCNC/linuxcnc/pull/2703
 
Last edit: 19 Oct 2023 06:13 by Vector. Reason: Flag that the pull request mentioned did not compile.

Please Log in or Create an account to join the conversation.

Time to create page: 0.078 seconds
Powered by Kunena Forum