openfx icon indicating copy to clipboard operation
openfx copied to clipboard

Documentation relative paths are wrong

Open armadsen opened this issue 4 years ago • 3 comments

Problem

I'm trying to go through the documentation to start learning OpenFX. Unfortunately, the directory structure of the sources seems to have been changed without a corresponding update to the documentation. In particular, make in openfx/Documentation/sources/Guide/Code fails because of include search paths. (They're an extra two parent directories up.)

Additionally, there is a link on the word 'there' on the following sentence from this page: https://openfx.readthedocs.io/en/doc/Guide/ofxExample1_Basics.html#basicexample in the following text:

An example plugin will be used to illustrate how all the machinery works, and its source can be found in the C++ file there.

That link points to https://github.com/ofxa/openfx/blob/master/Guide/Code/Example1/basics.cpp, which is a 404. I believe it should point to https://github.com/ofxa/openfx/blob/master/Documentation/sources/Guide/Code/Example1/basics.cpp. I think there are similarly incorrect links on other documentation pages.

armadsen avatar Oct 18 '21 21:10 armadsen

I'm happy to submit a PR to fix up some of this if that's helpful.

armadsen avatar Oct 18 '21 21:10 armadsen

The Makefile portion of this has already been fixed here: https://github.com/ofxa/openfx/pull/83 but the PR hasn't been merged yet.

armadsen avatar Oct 19 '21 19:10 armadsen

#83 has now been merged. Please submit a PR for the rest; that would be great!

garyo avatar Nov 09 '21 21:11 garyo