AcademySoftwareFoundation / AcademySoftwareFoundation/openfx

Documentation relative paths are wrong

Open
#87 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
570
Forks
152
PR merge metrics
No merged PRs in 30d

Description

### 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.

Contributor guide

Open the contributing guide

Research direction

Start with the documentation sources under Documentation/sources/Guide/Code and the ofxExample1_Basics page linked in the issue. Run make in that directory, inspect the include search paths and links to Guide/Code/Example1/basics.cpp, then check other documentation pages for the same path error. Done means the example builds and the referenced source links resolve.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.