Path wiki documentation: some issues / tasks

Here's the place for discussion related to CAM/CNC and the development of the Path module.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Post Reply
User avatar
Roy_043
Veteran
Posts: 8450
Joined: Thu Dec 27, 2018 12:28 pm

Path wiki documentation: some issues / tasks

Post by Roy_043 »

Some issues / tasks related to the Path wiki documentation:

1.
I have added 11 existing pages to the Path category. These pages should be checked. It may be a good idea to check all pages in the Path category. Some are perhaps obsolete, some have been marked as 'In progress' for a very long time now, etc.
The 11 pages are:
https://wiki.freecadweb.org/Path_Compound
https://wiki.freecadweb.org/Path_objects
https://wiki.freecadweb.org/Path_scripting
https://wiki.freecadweb.org/Path_Plane
https://wiki.freecadweb.org/Path_NewTool
https://wiki.freecadweb.org/Path_Core_Concepts
https://wiki.freecadweb.org/Path_SetupSheet
https://wiki.freecadweb.org/Path_Development_Roadmap
https://wiki.freecadweb.org/Path_Customization
https://wiki.freecadweb.org/Path_Hop
https://wiki.freecadweb.org/GSoC_Path/Robot_Integration
The Path category:
https://wiki.freecadweb.org/Category:Path

2.
On the Path WB page the headings and the order of the commands need to be checked.
Under the 'Path Commands' heading there are links that do not make sense. The 'Path Tools', 'Fourth Axis' and the 'Path Preferences' pages do not document commands.
The order of the commands on the wiki page is different from that in Path menu. This may be a deliberate choice. But even with that in mind I find it hard to understand that the 'Post Process' command comes 2nd in the menu but 4th on the wiki page.
https://wiki.freecadweb.org/Path_Workbench

3.
When the order mentioned under #2 is fixed, the Docnav order of the pages should be updated accordingly. The Docnav order is a mess currently.

I can do that last part, but not the first two.
User avatar
sliptonic
Veteran
Posts: 3457
Joined: Tue Oct 25, 2011 10:46 pm
Location: Columbia, Missouri
Contact:

Re: Path wiki documentation: some issues / tasks

Post by sliptonic »

Roy_043 wrote: Thu May 13, 2021 11:04 am Some issues / tasks related to the Path wiki documentation:
Thank you for working on this! I took a pass through and included my notes below on what I think should happen.
Let me know if any of this doesn't make sense.

https://wiki.freecadweb.org/Path_Compound ... obsolete. Can be removed.
https://wiki.freecadweb.org/Path_objects ... This page is weird. It's a mix of low-level programming concepts and high-level user-functionality. I'd suggest removal.
https://wiki.freecadweb.org/Path_scripting ... Still Valid. Please keep.
https://wiki.freecadweb.org/Path_Plane ... Deprecated. We don't do this anymore. Page should be removed.
https://wiki.freecadweb.org/Path_NewTool ... This is redundant with Path_ToolLibraryEdit. Recommend remove.
https://wiki.freecadweb.org/Path_Core_Concepts .. redundant with scripting, please remove
https://wiki.freecadweb.org/Path_SetupSheet ... Valid page. Needs to be integrated somewhere.
https://wiki.freecadweb.org/Path_Development_Roadmap ... Roadmap probably needs updating but the page is fine.
https://wiki.freecadweb.org/Path_Customization ... Not needed. Delete.
https://wiki.freecadweb.org/Path_Hop .. Deprecated. Please remove
https://wiki.freecadweb.org/GSoC_Path/Robot_Integration ... Still valid.
The Path category:
https://wiki.freecadweb.org/Category:Path ... Reviewed. Once the various deprecated pages are removed, I think this is fine.

On the Path WB page the headings and the order of the commands need to be checked.
Under the 'Path Commands' heading there are links that do not make sense. The 'Path Tools', 'Fourth Axis' and the 'Path Preferences' pages do not document commands.
Agreed. 4th axis is highly experimental and far from usable. That should only exist in the wiki as a place for devs to drop notes for later development.
Leave it on the wiki but feel free to remove links to it.

Path_Tools is more of a concept page. There's good info there but it should be part of the concepts section.
Same thing with the preferences. Good info, wrong place.

The order of the commands on the wiki page is different from that in Path menu. This may be a deliberate choice. But even with that in mind I find it hard to understand that the 'Post Process' command comes 2nd in the menu but 4th on the wiki page.

Agreed. That's bogus. Feel free to re-order them however you think makes sense.
User avatar
Roy_043
Veteran
Posts: 8450
Joined: Thu Dec 27, 2018 12:28 pm

Re: Path wiki documentation: some issues / tasks

Post by Roy_043 »

I have updated the Path_Workbench page. For the order of the commands I have followed the order of the Path menu. I have introduced a couple of paragraph headers that you may want to check (notably "Project Commands" and "Tool Commands").

The Docnav order of the pages has been changed accordingly. And the GuiCommand info has been updated.

I have worked on the Usage paragraphs of a couple of pages. But this really requires an editor who is knowledgeable about the WB and is willing to spend more time on this part of the documentation... Needless to say that not all pages are up to date.

For editors who are planning on working on the wiki documentation of the Path WB:
Please try to follow the standards:
https://wiki.freecadweb.org/GuiCommand_model
https://wiki.freecadweb.org/WikiPages
https://wiki.freecadweb.org/Help:Editing
Post Reply