Skip to content

docs: give G-code Examples its own heading - #4812

Open
revjmoney wants to merge 1 commit into
LinuxCNC:masterfrom
revjmoney:docs-gcode-examples-heading
Open

revjmoney wants to merge 1 commit into
LinuxCNC:masterfrom
revjmoney:docs-gcode-examples-heading

Conversation

@revjmoney

Copy link
Copy Markdown

Closes #2085

The G-code examples page was one entry inside "G-code Programming", which is easy to miss for readers who already know G-code. This gives it its own heading, as discussed in the issue (master, per @BsAtHome):

  • docs/src/index.tmpl: a new "G-code Examples" <details> section right after "G-code Programming"; the existing examples/gcode.html link moves into it.
  • docs/src/Master_Documentation.adoc: a new = G-code Examples part after "G-code Programming" that includes examples/gcode.adoc (leveloffset 2, like its neighbours), so the PDF matches.
  • docs/src/docs.xml: examples_gcode moved after gui_image-to-gcode, so the prev/next buttons follow the index order (per docs/README.adoc).

No page content or anchors change, so existing links keep working. Not built locally (no asciidoc toolchain on this machine); relying on the htmldocs check.

The examples page was one entry inside "G-code Programming", easy to
miss for readers who already know G-code. Give it its own section in
the HTML index and its own part in the PDF, placed right after
"G-code Programming", and keep docs.xml's prev/next order in step.
No page content or anchors change.

Closes LinuxCNC#2085
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Gcode examples should have a heading of it's own

1 participant