Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation relative paths are wrong #87

Open
armadsen opened this issue Oct 18, 2021 · 3 comments
Open

Documentation relative paths are wrong #87

armadsen opened this issue Oct 18, 2021 · 3 comments

Comments

@armadsen
Copy link

armadsen commented Oct 18, 2021

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
Copy link
Author

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

@armadsen
Copy link
Author

The Makefile portion of this has already been fixed here: #83 but the PR hasn't been merged yet.

@garyo
Copy link
Contributor

garyo commented Nov 9, 2021

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

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

No branches or pull requests

2 participants