How to report broken links in documentation

Discussions about the wiki documentation of FreeCAD and its translation.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Post Reply
casterle
Posts: 37
Joined: Tue Nov 08, 2022 7:49 pm

How to report broken links in documentation

Post by casterle »

How should I report a broken link in the documentation?

Specifically, on https://github.com/FreeCAD/FreeCAD-docu ... rkbench.md, the link in the 3rd paragraph to the definition of "constructive solid geometry" is broken.

Wikipedia has a good explanation of CSG here: https://en.wikipedia.org/wiki/Construct ... d_geometry
User avatar
Roy_043
Veteran
Posts: 8552
Joined: Thu Dec 27, 2018 12:28 pm

Re: How to report broken links in documentation

Post by Roy_043 »

The GitHub version of the documentation is created programmatically from the Wiki. Wiki links are case-sensitive, but the first letter is always automatically capitalized. [[Constructive_solid_geometry]] and [[constructive_solid_geometry]] will point to the same page on the Wiki. This is not the case on GitHub. This is one of several issues with the current FreeCAD documentation on GitHub. For now the advice is to use the Wiki documentation.
casterle
Posts: 37
Joined: Tue Nov 08, 2022 7:49 pm

Re: How to report broken links in documentation

Post by casterle »

Thank you for the quick response. I've changed the help preference from markdown to wiki, which seems to be the fix.
Post Reply