-
Notifications
You must be signed in to change notification settings - Fork 50
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
Improve doc #846
Improve doc #846
Conversation
e216275
to
c8e6e3c
Compare
Codecov Report
@@ Coverage Diff @@
## release-candidate #846 +/- ##
==================================================
Coverage 26.41% 26.41%
==================================================
Files 321 321
Lines 21410 21410
==================================================
Hits 5656 5656
Misses 15754 15754 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems quite a good improvement in readability. I'll fetch and compile the doc to verify the new structure and content.
BTW, perhaps you can add somewhere that we encourage users to have dedicated build directory and install directory (the later being manage automatically if the default install dir is used) for each build type (Release, Debug) and that compiling Radium in Debug mode needs to have the dependencies (at least assimp) compiled and installed in Debug mode.
Hum right, this is suggested at multiple places, but not clearly stated. I'll let you do you review run, and we will add that with your other suggestions (if any). |
24029b5
to
7c2912f
Compare
Maybe clean the history before merge ? (or squash, but I think two commit may be better) |
In the next days (or weeks), I'll propose a new section on "How to write your own plugin" so that even applications that do not support plugins can used the added functionalities (e.g. headless app). I gave an online course to master students, on the spirit of the "ExamplePluginWithLib" test folder, on how to do that and I just have to clean the used repo before submitting it as a PR. |
Co-authored-by: David Vanderhaeghe <github@dlyr.fr>
Variables starting by DOXYGEN_ are passed to doxygen
Btw, there is already a page called how to write your own plugin in the developer manual |
Sure, there is one and it is helpful for developing plugins. |
Improve documentation
Be aware that the PR request cannot be accepted if it doesn't pass the Continuous Integration tests.
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Update documentation structure and content
What is the current behavior? (You can also link to an open issue here)
Compilation instructions and dependency management is not clear and spread across pages
What is the new behavior (if this is a feature change)?
Simplify documentation to help new users understanding the build chain and use it.
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No
Other information: